Add README, CONTRIBUTING

and some other stuff...
This commit is contained in:
David Vierra 2014-12-28 22:01:52 -10:00
parent a25c0ab851
commit 8fdd19fb3e
8 changed files with 97 additions and 5 deletions

74
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,74 @@
# Reporting Issues
## MCEdit 2 is currently in pre-alpha. ONLY report issues where MCEdit does not start at all.
**Before** submitting an issue, read [Reporting Issues](https://github.com/mcedit/mcedit/wiki/Reporting-Issues) and be sure to include all of the required info in your description:
* **Steps to Reproduce** - Step by step, tell us exactly which buttons to click on, text to enter, and keys to press that lead you to discover the problem.
* **MCEdit Version Number** - Found in the title bar of the main window.
* **Minecraft Version Number** - You should already know how to find this. Also include a list of the mods you are using.
* **Operating System Version** - At the very least, say whether you are on Windows, Mac, or Linux. To get a more exact version (e.g. "Windows Vista SP1 64-bit", "Mac OS X 10.6.4"):
+ Windows: click Start, then right-click Computer and choose "Properties".
+ Mac OS X: Choose "About This Mac" from the Apple menu.
+ Linux: See your distro's documentation to find out how to get the version number.
+ An animal is not a version number.<br><br>
* **Error log** - If MCEdit tells you it had an error, there will be vital information inside the console window and/or error log file. On Windows, this is the file `mcedit.log` inside the `MCEdit-<version>-<platform>` folder. Use [pastebin](http://pastebin.com/) or [gist](https://gist.github.com/) for logs longer than a dozen lines. On Mac OS X, error info can be copied from the Console utility. (`mcedit.log` is also present on OS X, though it's buried deep inside the application bundle.) On Linux, the error log will be shown on the terminal you started MCEdit from.
The issue tracker is the preferred channel for [bug reports](#bugs),
[features requests](#features) and [submitting pull
requests](#pull-requests), but please respect the following restrictions:
* Please **do not** use the issue tracker for personal support requests (use the thread on the Minecraft forums or the official MCEdit forums (not yet available)). Asking for help is a personal support request.
<a name="bugs"></a>
## Bug reports
A bug is a _demonstrable problem_ when using MCEdit itself, or when loading a MCEdit-modified world into a vanilla Minecraft game. Modified versions of Minecraft are not officially supported.
Good bug reports are extremely helpful - thank you!
Guidelines for bug reports:
1. **Use the GitHub issue search** &mdash; check if the issue has already been
reported. The search box is right next to the "New Issue" button.
2. **Check if the issue has been fixed** &mdash; try to reproduce it using the
latest development builds from http://www.mcedit.net/
A good bug report shouldn't leave others needing to chase you up for more
information. Please try to be as detailed as possible in your report. What steps will reproduce the issue? What OS and Minecraft versions
experience the problem? What would you expect to be the outcome? If you use mods, have you tried a vanilla Minecraft install to confirm the problem is not mod-related? All these
details will help people to fix any potential bugs.
Example:
> Short and descriptive example bug report title
>
> Minecraft version(s):
> MCEdit version(s):
> Operating system(s):
> Mods installed:
>
> A summary of the issue. If suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
>
> Any other information you want to share that is relevant to the issue being
> reported. This might include the lines of code that you have identified as
> causing the bug, and potential solutions (and your opinions on their
> merits).
<a name="features"></a>
## Feature requests
Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.
## Contributing

View File

@ -1,4 +1,4 @@
Copyright (c) 2010-2013, David Rio Vierra Copyright (c) 2010-2015, David Rio Vierra
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
@ -9,4 +9,4 @@ Redistribution and use in source and binary forms, with or without modification,
Neither the name of the MCEdit project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. Neither the name of the MCEdit project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

5
README.md Normal file
View File

@ -0,0 +1,5 @@
# MCEdit 2.0
MCEdit 2.0 is currently in pre-alpha.
TODO: write the readme.

View File

@ -1,5 +1,10 @@
update lighting!!!!! update lighting (halfway there)
find or create a release framework
$ (cd dist; rm mcedit2-tech-demo.exe; mkdir mcedit2-tech-demo; mv mcedit2.exe mcedit2-tech-demo/; /c/Program\ Files/7-Zip/7z a -sfx7z.sfx mcedit2-tech-demo.exe mcedit2-tech-demo -m0=Copy)
exclude assets_raw from pyinstaller
add a way to resize the selection box when the iso view is head-on with a face add a way to resize the selection box when the iso view is head-on with a face
disjoint selections (halfway there, just need UI) disjoint selections (halfway there, just need UI)

View File

@ -277,7 +277,7 @@ class CutawaySliceWheelAction(ViewMouseAction):
delta = event.delta() delta = event.delta()
if delta == 0: if delta == 0:
return return
p = list(event.view.centerPoint) p = list(event.view.centerPoint)
p[event.view.dim] += delta / abs(delta) p[event.view.dim] += delta / abs(delta)

View File

@ -391,6 +391,7 @@ class AnvilWorldAdapter(object):
:type filename: str or unicode :type filename: str or unicode
:type create: bool :type create: bool
:type readonly: bool :type readonly: bool
:rtype: AnvilWorldAdapter
""" """
self.lockTime = 0 self.lockTime = 0

View File

@ -79,6 +79,13 @@ class NBTListAttr(object):
class CompoundAttrs(object): class CompoundAttrs(object):
def __init__(self, rootTag): def __init__(self, rootTag):
"""
:param rootTag:
:type rootTag: nbt.TAG_Compound
:return:
:rtype:
"""
super(CompoundAttrs, self).__init__() super(CompoundAttrs, self).__init__()
self.rootTag = rootTag self.rootTag = rootTag
# xxx parent instance.dirty # xxx parent instance.dirty

View File

@ -489,7 +489,7 @@ class WorldEditor(object):
self.dimensions[dimName] = dim self.dimensions[dimName] = dim
return dim return dim
class WorldEditorDimension(): class WorldEditorDimension(object):
def __init__(self, worldEditor, dimName): def __init__(self, worldEditor, dimName):
self.worldEditor = worldEditor self.worldEditor = worldEditor
self.adapter = worldEditor.adapter self.adapter = worldEditor.adapter