Skip to content
This repository has been archived by the owner on Jun 22, 2021. It is now read-only.

Latest commit

 

History

History
83 lines (57 loc) · 3.38 KB

README.md

File metadata and controls

83 lines (57 loc) · 3.38 KB
Raw

Amulet Map Editor

CircleCI Documentation Status

A new Minecraft world editor that aims to be flexible, extendable, and support most editions of Minecraft.

Requirements

For Running From Source

  • Python 3.7.0+
  • Numpy
  • pyglet
  • NBT

Shortcut: pip install -r requirements.txt

For Development

Shortcut: pip install -r requirements-dev.txt (This also installs the requirements required for running from source)

For more information about contributing to this project, please see the contribution section below

Running

Command-line

To run the program in command line mode, run the following command in your operating system's console: Amulet_Map_Editor --command-line

Documentation

Our online documentation can be found here: https://amulet-map-editor.readthedocs.io/en/latest/

Building the Documentation

To build the documentation locally, run the following command: make html and then navigate to the generated directory docs_build/html in your favorite web browser

Contributing

Running from Source

  1. Clone the project using git clone https://github.com/Amulet-Team/Amulet-Map-Editor
  2. When inside the folder you cloned, install the requirements using pip install -r requirements.txt
  3. To format your files automatically before committing changes, use pre-commit install

Branch Naming

Branches should be created when a certain bug or feature may take multiple attempts to fix. Naming them should follow the following convention (even for forked repositories when a pull request is being made):

  • For features, use: impl-<feature name>
  • For bug fixes, use: bug-<bug tracker ID>
  • For improvements/rewrites, use: improv-<feature name>
  • For prototyping, use: proto-<feature name>

Code Formatting

For code formatting, we use the formatting utility black. To run it on a file, run the following command from your favorite terminal after installing: black <path to file>

While formatting is not strictly required for each commit, we ask that after you've finished your code changes for your Pull Request to run it on every changed file.

Pull Requests

We ask that submitted Pull Requests give moderately detailed notes about the changes and explain any changes that were made to the program outside of those directly related to the feature/bug-fix. Please make sure to run all tests and include a written verification that all tests have passed.

Note: We will also re-run all tests before reviewing, this is to mitigate additional changes/commits needed to pass all tests.

Once a Pull Request is submitted, we will mark the request for review, once that is done, we will review the changes and provide any notes/things to change. Once all additional changes have been made, we will merge the request.

License

This software is available under the MIT license.