Configuration

Configurations

GuidebookApi use a custom Configuration System, this is very simple for developers and doesn't strictly need Neoforge or Fabric, it can be used everywhere but thats not the point ( at all ).

GuidebookApi provides two configuration files with this system:

- **GuidebookApi_Common.properties**
- **GuidebookApi_Client.properties**

Both files are on the config directory of the loader.

GuidebookApi_Common.properties

The GuidebookApi_Common.properties file provides configuration for the player spawn in the world.

Configuration	Type	Description	Default Value	Example
shouldSpawnWithBook	boolean	If true, this configuration overrides all the book configurations and let (or doesn't) the player spawn with the books who have their own shouldSpawnWithBook in true	true	shouldSpawnWithBook=false
spawn.<namespace>.<path>	boolean	If true, the player can spawn with the book of that parameters ( and if the global shouldSpawnWithBook ) is enabled	book data	spawn.example.exampleguide=true

GuidebookApi_Client.properties

The GuidebookApi_Client.properties file provides all the client configurations.

Configuration	Type	Description	Default Value	Example
textColor	color	Define the color of all the texts in the books	rgb(164, 135, 124)	rgb(255, 0, 0)
entryColor	color	The color of the entries when the mouse isn't between this.	rgb(75, 61, 54)	rgb(255, 255, 0)
entryBetweenColor	color	The color of the entries when the mouse is between this.	rgb(39, 26, 23)	rgb(255, 255, 255)
bookColor.namespace.path	color	The color of the book with the namespace and path of the id	rgb(book.red, book.green, book.blue)	bookColor.example.exampleguide=rgb(255, 0, 255)
bookColor.pages.namespace.path	color	The color of the book screen tops with the namespace and path of the id	rgb(book.pageColor.red, book.pageColor.green, book.pageColor.blue)	bookColor.pages.example.exampleguide=rgb(0, 255, 255)