make the root readme more dev focused & move the blurb-y one to the mod dir
This commit is contained in:
dags-
parent
04cb43c6e0
commit
6d37357fc2
65
README.md
65
README.md
@ -1,60 +1,17 @@
|
||||
# TerraForged
|
||||
|
||||
[](https://ci.dags.me/job/TerraForged/)
|
||||
TerraForged is a small collection of projects centered around procedurally generated worlds.
|
||||
The primary outlet of which is a Forge mod for the popular game Minecraft (Java Edition).
|
||||
|
||||
|
||||
### Building From Source
|
||||
|
||||
#### About:
|
||||
TerraForged is an ambitious new terrain generator mod for Minecraft (Java Edition) attempting to
|
||||
create more immersive, inspiring worlds to explore and build in. Featuring an overhaul of the
|
||||
vanilla generation system, custom terrain shapes, simulated erosion, better rivers, custom
|
||||
decorations, tonnes of configuration options, and more!
|
||||
The project relies on Gradle for build and dependency management. In order to compile you need
|
||||
to use the maven-publish task, with the mod binary being located under the 'TerraForgedMod'
|
||||
sub-project.
|
||||
|
||||
#### Website(s):
|
||||
[https://terraforged.com](https://terraforged.com)
|
||||
[https://github.com/TerraForged](https://github.com/TerraForged)
|
||||
[https://curseforge.com/../TerraForged](https://www.curseforge.com/minecraft/mc-mods/terraforged)
|
||||
Command:
|
||||
```shell script
|
||||
./gradlew publish
|
||||
```
|
||||
|
||||
#### Installation:
|
||||
1. Install forge for the target version of Minecraft (ie 1.15.2)
|
||||
2. Add the TerraForged mod jar to your profile's mods folder
|
||||
3. Select the '`TerraForged`' world-type when creating a new world
|
||||
|
||||
#### Features:
|
||||
- Varied and immersive terrain
|
||||
- Erosion and improved rivers
|
||||
- Custom features and decoration
|
||||
- Extensive configuration options & in-game GUI
|
||||
|
||||
|
||||
|
||||
#### FAQ:
|
||||
1) "Is this compatible with mod xyz?"
|
||||
_Probably! (to some degree) - TerraForged is designed to work with many of the same world-gen systems
|
||||
that the majority of block & biome providing mods use. Certain biomes' terrain may not always look
|
||||
exactly as their author designed but should otherwise be compatible. Feel free to report any other
|
||||
compatibility issues on the issue tracker._
|
||||
|
||||
2) "How can I use this on my server?"
|
||||
_When Forge supports it, you can simply set level-type=terraforged in your server.properties file. In
|
||||
the meantime, you will need to create the world in single player and then copy that to your server
|
||||
directory. (In both cases, TerraForged must be installed on the client and the server)._
|
||||
|
||||
3) "Will I need a super-computer to run this?!"
|
||||
_No, not really - while this world generator will be a bit slower than vanilla's (on account of it
|
||||
doing more work to make things look nice), it would only be apparent when first generating a chunk -
|
||||
they might load in slower when moving to new parts of the world, but game performance should
|
||||
otherwise be normal. A 4-core CPU should be able to handle this just fine._
|
||||
|
||||
4) "Can this be ported Fabric/Bukkit/Spigot/Sponge?"
|
||||
_If someone would like to take this task on, yes - a large part of the TerraForged codebase is already
|
||||
platform independent. There are certain client-side features in the forge-mod that would not translate
|
||||
onto server-only APIs, but the core experience could certainly be ported. I don't intend to work on
|
||||
this directly but others are very welcome._
|
||||
|
||||
5) "Will this be back-ported to older Forge versions?"
|
||||
_Not by myself, no - My aim is to keep current with Forge. I'm simply not prolific enough a modder to
|
||||
write and maintain for multiple versions (hats off to those who do!). Again though, others are welcome
|
||||
to back-port it, if inclined to do so._
|
||||
|
||||
[View more questions on Github](https://github.com/TerraForged/TerraForged/issues?q=label:question)
|
||||
// TODO - more
|
||||
|
||||
@ -1,7 +1,56 @@
|
||||
# TerraForged
|
||||
|
||||
|
||||
### Commands
|
||||
- `/terra query` - print the Terrain and Biome types at your location
|
||||
- `/terra find <biome>` - find the nearest instance of the given biome type
|
||||
- `/terra find <terrain>` - find the nearest instance of the given terrain type
|
||||
- `/terra find <terrain> <biome>` - find the nearest instance of the given terrain and biome type
|
||||
#### About:
|
||||
TerraForged is an ambitious new terrain generator mod for Minecraft (Java Edition) attempting to
|
||||
create more immersive, inspiring worlds to explore and build in. Featuring an overhaul of the
|
||||
vanilla generation system, custom terrain shapes, simulated erosion, better rivers, custom
|
||||
decorations, tonnes of configuration options, and more!
|
||||
|
||||
#### Website(s):
|
||||
[https://terraforged.com](https://terraforged.com)
|
||||
[https://github.com/TerraForged](https://github.com/TerraForged)
|
||||
[https://curseforge.com/../TerraForged](https://www.curseforge.com/minecraft/mc-mods/terraforged)
|
||||
|
||||
#### Installation:
|
||||
1. Install forge for the target version of Minecraft (ie 1.15.2)
|
||||
2. Add the TerraForged mod jar to your profile's mods folder
|
||||
3. Select the '`TerraForged`' world-type when creating a new world
|
||||
|
||||
#### Features:
|
||||
- Varied and immersive terrain
|
||||
- Erosion and improved rivers
|
||||
- Custom features and decoration
|
||||
- Extensive configuration options & in-game GUI
|
||||
|
||||
|
||||
|
||||
#### FAQ:
|
||||
1) "Is this compatible with mod xyz?"
|
||||
_Probably! (to some degree) - TerraForged is designed to work with many of the same world-gen systems
|
||||
that the majority of block & biome providing mods use. Certain biomes' terrain may not always look
|
||||
exactly as their author designed but should otherwise be compatible. Feel free to report any other
|
||||
compatibility issues on the issue tracker._
|
||||
|
||||
2) "How can I use this on my server?"
|
||||
_When Forge supports it, you can simply set level-type=terraforged in your server.properties file. In
|
||||
the meantime, you will need to create the world in single player and then copy that to your server
|
||||
directory. (In both cases, TerraForged must be installed on the client and the server)._
|
||||
|
||||
3) "Will I need a super-computer to run this?!"
|
||||
_No, not really - while this world generator will be a bit slower than vanilla's (on account of it
|
||||
doing more work to make things look nice), it would only be apparent when first generating a chunk -
|
||||
they might load in slower when moving to new parts of the world, but game performance should
|
||||
otherwise be normal. A 4-core CPU should be able to handle this just fine._
|
||||
|
||||
4) "Can this be ported Fabric/Bukkit/Spigot/Sponge?"
|
||||
_If someone would like to take this task on, yes - a large part of the TerraForged codebase is already
|
||||
platform independent. There are certain client-side features in the forge-mod that would not translate
|
||||
onto server-only APIs, but the core experience could certainly be ported. I don't intend to work on
|
||||
this directly but others are very welcome._
|
||||
|
||||
5) "Will this be back-ported to older Forge versions?"
|
||||
_Not by myself, no - My aim is to keep current with Forge. I'm simply not prolific enough a modder to
|
||||
write and maintain for multiple versions (hats off to those who do!). Again though, others are welcome
|
||||
to back-port it, if inclined to do so._
|
||||
|
||||
[View more questions on Github](https://github.com/TerraForged/TerraForged/issues?q=label:question)
|
||||
Loading…
Reference in New Issue
Block a user