Skip to content

Commit

Permalink
Proofread README documentation. In particular: Changeling is no longe…
Browse files Browse the repository at this point in the history
…r a required dependency for core, only for the creatures submod
  • Loading branch information
asanetargoss committed Nov 7, 2021
1 parent 4ebe595 commit fc04edd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Hardcore Alchemy mod suite is released under the LGPL 3, so you are allowed

The Hardcore Alchemy mod suite is designed around the following mechanics:

* **Balanced shapeshifting** - [Changeling](https://github.com/asanetargoss/Changeling/releases) powers Hardcore Alchemy's balanced morphing features, and is a required dependency.
* **Balanced shapeshifting** - [Changeling](https://github.com/asanetargoss/Changeling/releases) powers Hardcore Alchemy's balanced morphing features.
* The following config options should be set in Changeling: `acquire_immediately=false`, `disable_morph_disguise=true`, and `keep_morphs=false`
* **Random respawn on death** - The Hardcore Alchemy mod is designed around hardcore respawn. For this, I recommend [Iberia HcA edition](https://github.com/asanetargoss/iberia/releases).

Expand Down Expand Up @@ -51,16 +51,16 @@ Please note: The following mods included in the HcA_compilelibs zip file above a
* Guide-API (Custom build for development use only. Do not distribute.)
* AppleCore: https://github.com/asanetargoss/AppleCore

### Overview of Projects and Dependencies
### Overview of Projects

* `compilelibs/` - The place to put third-party mods that the various projects depend on. For example, files in `compilelibs/core` are depended on by the core project and any mods which depend on the core project.
* `translations/` - Unlike most mod projects, translation files are stored in this folder, separately from other resources. Most of the translation files are in `translations/core/`, but this may change in the future.
* `compilelibs/` - The place to put third-party mods that the various projects depend on. For example, files in `compilelibs/core/` are depended on by the core project and any mods which depend on the core project.
* `translations/` - Unlike most mod projects, translation files are stored in this folder, separately from other resources. Most of the translations are in `translations/core/`, but this may change in the future.
* `core/` - A mod project which contains shared code required by the other projects.
* `tweaks/` - A mod project containing magic and survival tweaks, aiming for a minimal number of dependencies.
* `creatures/` - A mod project for balanced morphing mechanics and tweaks to mob mods.
* `creatures/` - A mod project for balanced morphing mechanics and tweaks to mob mods. It requires Changeling.
* `magic/` - A mod project containing features which make magic mods work better in a hardcore respawn gameplay context. It also contains various tweaks and fixes for magic and utility mods.
* `survival/` - A mod project containing various features related to nutrition, thirst, and crop growth. It interacts with various survival and crop mods.
* `modpack/` - A mod project intended for the Hardcore Alchemy modpack. It adds guidebooks and integration tests.
* `modpack/` - A mod project intended for the Hardcore Alchemy modpack. It adds guidebooks and integration tests. If you are building your own modpack, you most likely do not want to use this mod.

### Notes on Windows and IntelliJ IDEA

Expand Down
4 changes: 3 additions & 1 deletion testconfig/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
**WARNING**: Some of the configs in `[PROJECT_NAME]/run/config/` will be overridden when running gradle commands. If you want a config change to be permanent, edit its corresponding file in `runconfigs/`.
**WARNING**: Some of the configs in `[PROJECT_NAME]/run/config/` will be overridden when running gradle commands. If you want a config change to be permanent, edit its corresponding file in `testconfig/`.

Also, in case you're wondering: No, these are not the config files for the Hardcore Alchemy modpack. They are mostly stock config files, with a few changes to make development easier.

0 comments on commit fc04edd

Please sign in to comment.