Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clamytoe/mc_enchant
Little utility to facilitate with generating the code needed to spawn enchanted objects in Minecraft
https://github.com/clamytoe/mc_enchant
Last synced: 2 days ago
JSON representation
Little utility to facilitate with generating the code needed to spawn enchanted objects in Minecraft
- Host: GitHub
- URL: https://github.com/clamytoe/mc_enchant
- Owner: clamytoe
- License: mit
- Created: 2019-05-22T14:20:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T12:08:46.000Z (4 months ago)
- Last Synced: 2024-07-08T15:04:57.363Z (4 months ago)
- Language: Python
- Size: 38.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minecraft Enchantments Generator (*mc_enchant*)
> *Little utility to facilitate with generating the code needed to spawn enchanted objects in Minecraft*
![Python version][python-version]
![Latest version][latest-version]
[![Build Status][travis-image]][travis-url]
[![BCH compliance][bch-image]][bch-url]
[![GitHub issues][issues-image]][issues-url]
[![GitHub forks][fork-image]][fork-url]
[![GitHub Stars][stars-image]][stars-url]
[![License][license-image]][license-url]
NOTE: This app was generated with [Cookiecutter](https://github.com/audreyr/cookiecutter) along with [@clamytoe's](https://github.com/clamytoe) [toepack](https://github.com/clamytoe/toepack) project template.
The app is currently in its Initial stages and so far only scrapes [digminecraft.com](https://www.digminecraft.com/lists/enchantment_list_pc.php) for all available enchantments in vanilla Minecraft and generates either a *CSV* or *JSON* file. I still haven't decided which format I should stick with and will decide once I've played around with them both.
### Initial setup
```zsh
cd Projects
git clone https://github.com/clamytoe/mc_enchant.git
cd mc_enchant
```
#### Anaconda setup
If you are an Anaconda user, this command will get you up to speed with the base installation.
```zsh
conda env create
conda activate mc
```
#### Regular Python setup
If you are just using normal Python, this will get you ready, but I highly recommend that you do this in a virtual environment. There are many ways to do this, the simplest using *venv*.
```zsh
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
```
#### Final setup
```zsh
pip install -e .
```
## Usage
```zsh
mc_enchant
```
## Contributing
Contributions are very welcome. Tests can be run with with `pytest -v`, please ensure that all tests are passing and that you've checked your code with the following packages before submitting a pull request:
* black
* isort
* mypy
I am not adhering to them strictly, but try to clean up what's reasonable.
## License
Distributed under the terms of the [MIT](https://opensource.org/licenses/MIT) license, "mc_enchant" is free and open source software.
## Issues
If you encounter any problems, please [file an issue](https://github.com/clamytoe/toepack/issues) along with a detailed description.
## Changelog
* **v0.1.0** Initial commit.
[python-version]:https://img.shields.io/badge/python-3.7-brightgreen.svg
[latest-version]:https://img.shields.io/badge/version-0.1.0-blue.svg
[travis-image]:https://travis-ci.org/clamytoe/mc_enchant.svg?branch=master
[travis-url]:https://travis-ci.org/clamytoe/mc_enchant
[bch-image]:https://bettercodehub.com/edge/badge/clamytoe/mc_enchant?branch=master
[bch-url]:https://bettercodehub.com/
[issues-image]:https://img.shields.io/github/issues/clamytoe/mc_enchant.svg
[issues-url]:https://github.com/clamytoe/mc_enchant/issues
[fork-image]:https://img.shields.io/github/forks/clamytoe/mc_enchant.svg
[fork-url]:https://github.com/clamytoe/mc_enchant/network
[stars-image]:https://img.shields.io/github/stars/clamytoe/mc_enchant.svg
[stars-url]:https://github.com/clamytoe/mc_enchant/stargazers
[license-image]:https://img.shields.io/github/license/clamytoe/mc_enchant.svg
[license-url]:https://github.com/clamytoe/mc_enchant/blob/master/LICENSE