Amulet-Map-Editor/README.md

# Amulet Map Editor

![Build](../../workflows/Build/badge.svg)
![Unittests](../../workflows/Unittests/badge.svg?event=push)
![Stylecheck](../../workflows/Stylecheck/badge.svg?event=push)
[![Documentation Status](https://readthedocs.org/projects/amulet-map-editor/badge)](https://amulet-map-editor.readthedocs.io)

A new Minecraft world editor and converter that supports all versions since Java 1.12 and Bedrock 1.7.

![edit](resource/img/edit.jpg)

## Running compiled builds

Download the zip file for your operating system from the list of [compiled builds](https://github.com/Amulet-Team/Amulet-Map-Editor/releases). (Currently Windows only)

Extract the contained folder to a location on your computer and run the executable.

## Running from Source

**If you are running a compiled build you do NOT need to do this.**

1) Install [Python 3.9+](https://www.python.org/)
2) We recommend setting up a [python virtual environment](https://docs.python.org/3/tutorial/venv.html) so you don't run into issues with dependency conflicts.
3) run `python -m pip install amulet-map-editor` to install the library and all its dependencies.
4) run `python -m amulet_map_editor` to run the program

### Notes

If you have python 2 installed `python` may point to the wrong version in which case you will have to swap out `python` for `python3`

When installing from source the following dependencies will be installed

- numpy
- wxpython
- pyopengl
- [Amulet-Core](https://github.com/Amulet-Team/Amulet-Core)  The library to handle loading and saving data to the world formats.
- [Amulet-NBT](https://github.com/Amulet-Team/Amulet-NBT)  The library to handle reading and saving NBT and SNBT.
- [PyMCTranslate](https://github.com/gentlegiantJGC/PyMCTranslate)  The library to handle block, block entity, entity and biome translation. between versions
- [Minecraft-Model-Reader](https://github.com/gentlegiantJGC/Minecraft-Model-Reader)  The library to handle loading block models and textures from a resource pack for use in the renderer.
- [Amulet-LevelDB](https://github.com/Amulet-Team/Amulet-LevelDB)  The wrapper for Mojang's custom LevelDB.

## Contributing

For information about contributing to this project, please read the [contribution](contributing.md) file.
Create README.md 2019-11-24 12:22:10 -05:00			`# Amulet Map Editor`

Updated the readme 2020-11-15 12:19:48 +00:00			`![Build](../../workflows/Build/badge.svg)`
			`![Unittests](../../workflows/Unittests/badge.svg?event=push)`
			`![Stylecheck](../../workflows/Stylecheck/badge.svg?event=push)`
			`[![Documentation Status](https://readthedocs.org/projects/amulet-map-editor/badge)](https://amulet-map-editor.readthedocs.io)`
Create README.md 2019-11-24 12:22:10 -05:00
Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00			`A new Minecraft world editor and converter that supports all versions since Java 1.12 and Bedrock 1.7.`
Added info about compiled builds to the readme 2020-04-03 10:22:16 +01:00
Added editor image to readme 2020-04-03 10:44:03 +01:00			`![edit](resource/img/edit.jpg)`

Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00			`## Running compiled builds`
Added info about compiled builds to the readme 2020-04-03 10:22:16 +01:00
			`Download the zip file for your operating system from the list of [compiled builds](https://github.com/Amulet-Team/Amulet-Map-Editor/releases). (Currently Windows only)`

			`Extract the contained folder to a location on your computer and run the executable.`
Create README.md 2019-11-24 12:22:10 -05:00
Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00			`## Running from Source`
Create README.md 2019-11-24 12:22:10 -05:00
Updated the readme 2020-11-15 12:19:48 +00:00			`If you are running a compiled build you do NOT need to do this.`
Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00
Removed Python 3.9 limit (#923) A versions of wxpython has been released that has builds for newer versions of python. Updated build system to use 3.9 because the new version of wxpython does not have builds for 3.7 2023-06-18 17:22:49 +01:00			`1) Install [Python 3.9+](https://www.python.org/)`
Updated the readme 2020-11-15 12:19:48 +00:00			`2) We recommend setting up a [python virtual environment](https://docs.python.org/3/tutorial/venv.html) so you don't run into issues with dependency conflicts.`
			3) run `python -m pip install amulet-map-editor` to install the library and all its dependencies.
Fixed run command in the readme 2021-05-26 09:27:07 +01:00			4) run `python -m amulet_map_editor` to run the program
Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00
Updated the readme 2020-11-15 12:19:48 +00:00			`### Notes`
Create README.md 2019-11-24 12:22:10 -05:00
Updated the readme 2020-11-15 12:19:48 +00:00			If you have python 2 installed `python` may point to the wrong version in which case you will have to swap out `python` for `python3`
Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00
Updated the readme 2020-11-15 12:19:48 +00:00			`When installing from source the following dependencies will be installed`
Modified readme to add linux requirements.txt 2020-05-06 11:41:15 +01:00
Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00			`- numpy`
			`- wxpython`
			`- pyopengl`
			`- [Amulet-Core](https://github.com/Amulet-Team/Amulet-Core) The library to handle loading and saving data to the world formats.`
			`- [Amulet-NBT](https://github.com/Amulet-Team/Amulet-NBT) The library to handle reading and saving NBT and SNBT.`
			`- [PyMCTranslate](https://github.com/gentlegiantJGC/PyMCTranslate) The library to handle block, block entity, entity and biome translation. between versions`
			`- [Minecraft-Model-Reader](https://github.com/gentlegiantJGC/Minecraft-Model-Reader) The library to handle loading block models and textures from a resource pack for use in the renderer.`
Add a dependency in README (#1005) 2023-12-08 19:24:52 +08:00			`- [Amulet-LevelDB](https://github.com/Amulet-Team/Amulet-LevelDB) The wrapper for Mojang's custom LevelDB.`
Create README.md 2019-11-24 12:22:10 -05:00
			`## Contributing`

Updated requirements also tweaked some other things 2020-04-03 11:00:34 +01:00			`For information about contributing to this project, please read the [contribution](contributing.md) file.`