diff --git a/README.en-US.md b/README.en-US.md new file mode 100644 index 0000000..6485fd3 --- /dev/null +++ b/README.en-US.md @@ -0,0 +1,64 @@ +# Grus + +A cultivation plugin based on BukkitAPI + +[![Java CI with Gradle](https://github.com/602723113/Grus/actions/workflows/gradle.yml/badge.svg)](https://github.com/602723113/Grus/actions/workflows/gradle.yml) + +> Seeking immortality through cultivation, passionate and unrestrained, treading on lotuses and gliding over waves to cleanse the sword bone, riding the void and commanding the wind to mold a holy soul! —— 《A Will Eternal / Mortal's Journey to Immortality》 + +### Realm Chapter + +In Grus's [default configuration](https://github.com/602723113/Grus/blob/main/src/main/resources/config.yml), the realms of cultivators are divided into ten stages: `Qi Condensation, Early Foundation Establishment, Middle Foundation Establishment, Peak Foundation Establishment, Golden Core, Nascent Soul, Spirit Severing, Void Refinement, Body Integration, and Great Ascension`. + +| Realm | Required Cultivation | +|:---:|:---:| +| Qi Condensation | 500 | +| Early Foundation Establishment | 1500 | +| Middle Foundation Establishment | 7500 | +| Peak Foundation Establishment | 15000 | +| Golden Core | 50000 | +| Nascent Soul | 500000 | +| Spirit Severing | 5000000 | +| Void Refinement | 50000000 | +| Body Integration | 500000000 | +| Great Ascension | 5000000000 | + +The **Cultivation Value**[^1] required for each realm can be customized. Additionally, you can add or modify the realm configurations in `config.yml`, allowing different servers to have different cultivation modes. + +[^1]: Cultivation Value: Refers to the experience points accumulated by a player during cultivation. + +Please refer to `config.yml` for more detailed information. + +--- + +### Spiritual Root Chapter + +Spiritual Roots refer to the attributes of a cultivator, representing their innate aptitude for cultivation. Special techniques can be configured so that they can only be learned by those with specific spiritual roots. + +In Grus's [default configuration](https://github.com/602723113/Grus/blob/main/src/main/resources/config.yml), the five default spiritual roots are: `Metal, Wood, Water, Fire, and Earth`. You can define more spiritual roots within `config.yml`, and spiritual root attributes fully support customization. + +After a player obtains spiritual roots, the following effects apply: + +- **Heavenly Spiritual Root**: A single-attribute root with abundant energy. The cultivation speed is several times faster than ordinary roots. +- **True Spiritual Root**: Roots with two or three attributes, each being abundant. The cultivation speed is relatively fast. +- **Pseudo Spiritual Root**: Roots with four or five attributes, which are fragmented and insufficient. Since no single attribute is complete, the cultivation speed is very slow. + +Cultivation speed settings can be adjusted within `config.yml`. + +--- + +### Magic Treasure Chapter + +Please see [Grus-MagicTreasures](https://github.com/GrusWorld/Grus-MagicTreasures) + +--- + +### Talisman Chapter + +TBD (Waiting for documentation) + +--- + +### Technique Chapter + +TBD (Waiting for documentation)