documentation, default configuration changes

This commit is contained in:
Xevion
2019-08-11 03:09:09 -05:00
parent ee0889029b
commit c93d16fa4e
3 changed files with 143 additions and 120 deletions

23
README.md Normal file
View File

@@ -0,0 +1,23 @@
# fusion-fission-choices
## What is this repository?
`fusion-fission-choices` is a simple utility written in Python for identifying preferable elements to use for fusion with the Alchemistry Minecraft Mod.
## Configuration Options
The `elements` portion refers to the scores of each element, each being the atomic number of the element.
---
`minimumScore` refers to the mimimum score all elements must reach to be printed out. Settings this to -1 will make all elements be printed out.
---
`noNegatives` refers to whether it should filter out elements that have a negative score (ie. while using default configs, filter out elements without a score set)
A set of elements with the score (-1, 5) would get filtered out, while a set with the scores (78, 12) would not.
---
`fullPrint` refers to whether it should print out the Symbol or the Name of the Element