Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meza/achievementbooks
A Minecraft mod adding the possibility of multiple achievement books.
https://github.com/meza/achievementbooks
minecraft minecraft-forge minecraft-forge-mod minecraft-mod
Last synced: about 1 month ago
JSON representation
A Minecraft mod adding the possibility of multiple achievement books.
- Host: GitHub
- URL: https://github.com/meza/achievementbooks
- Owner: meza
- License: gpl-3.0
- Created: 2017-02-04T21:48:23.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-01-16T16:04:43.000Z (10 months ago)
- Last Synced: 2024-04-14T18:09:36.020Z (7 months ago)
- Topics: minecraft, minecraft-forge, minecraft-forge-mod, minecraft-mod
- Language: Java
- Homepage: https://discord.gg/dvg3tcQCPW
- Size: 5.85 MB
- Stars: 4
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
> @meza - http://twitch.tv/vsbmeza3 - http://twitter.com/vsbmeza3
# Achievement Books - for FABRIC (since 1.18.1+)
The Achievement Books mod introduces the ability to create * multiple * achievement books for Minecraft.
It is highly configurable via JSON to have headers, free flow text and achievement checklists on multiple pages.
## Why use this mod?
- you can have multiple achievement books for different parts of your game
- you don't need to deal with difficult formatting files
- you can describe your books in an easy-to-read format
- you can add/remove/edit entries without players losing their achievement progress
- you can reload the books from the config without restarting the game (not since 1.18.1)
## User Manual
### Installing the Mod
Make sure you're using [Fabric](http://fabricmc.net/)
To install the mod, head over to the project's page on [CurseForge https://minecraft.curseforge.com/projects/achievement-books](https://minecraft.curseforge.com/projects/achievement-books)
and download it into your minecraft installation's `mods` folder.
Note, that this is the same process for servers or clients.
> If your minecraft game is running, you need to restart it for the mod to be loaded into the game.
### Getting Started
As the mod starts the first time, you will have an example config created for you.
You can access the achievement book by:
```
/ab give
```
This will give you a mini achievement list on how to get to know the mod better.
This book is configured at ```config/achievementbooks/demo.json```
I recommend you go through the book in the game and do all the exercises there to fully understand what the mod is or is not.
### Commands
The mod listens to
```
/ab
```
#### Give
```
/ab give
```
Gives the player _every_ book registered in the system
#### List
```
/ab list
```
Lists all registered books and their IDs
#### Init
```
/ab init
```
Re-creates the demo.json file in the config folder if you ever need to reset it.
---
### Configuration
All books are configured in an easy to read JSON file. The contents of the file represent a JSON Object, so it must start with a `{`
and must and with a `}`.
Like this:
```JSON
{}
```
The most minimal valid book is as follows:
```JSON
{
"itemName": "book_smallest",
"bookName": "The smallest book",
"pages": []
}
```
#### `itemName` - required
This identifies the book in the item registry of the game. This needs to be unique for every book you create.
In the game, you'll be able to use: ```/give @p achievementbooks:book_smallest``` if you wish
Since it's used to identify books in sava data too, if you change this after you've started using the mod, you may lose
your progress.
#### `bookName` - required
A book's name is the most important feature of the book. This is how it shows up in the game, and this is how it's identified.
Unfortunately this means that the only thing that cannot be edited easily after the fact, is the book name. So choose carefully.
#### `craftingMaterial` - optional
Every book in the Achievement Books mod can be configure to be craftable or not. If you specify a crafting material in a `mod:item` format,
then the book will be craftable with that material and a book.
For example if you specify: `minecraft:cobblestone` as the crafting material, then if you put a regular book and a cobblestone in a crafting grid
next to eachother, it will create your book.
#### `color` / `colour` - optional
There are currently 16 colours you can use for your book. These are:
Colour parameter | Book icon
--------------- | ---------
aqua | 
black | 
blue | 
brown | 
deepblue | 
gray | 
green | 
lime | 
olive | 
orange | 
orangered | 
peach | 
pink | 
purple | 
red | 
yellow | 
```JSON
{
"itemName": "coloured_book_smallest",
"color": "orange",
"bookName": "The smallest book",
"pages": []
}
```
#### `pages` - required
The second most important part of the book is the list of pages it has.
This is an array of arrays of page items, which means that the general format is:
```JSON
{
"itemName": "book_example",
"bookName": "Page example book",
"pages": [
[],
[],
[]
]
}
```
This adds 3 empty pages to the book.
You can populate each page with a list of page items. Their configuration is as follows:
#### Page Items
Page items are JSON Objects again, which means they all need to be surrounded by `{` and `}`.
There are currently 3 types of elements that you can define:
##### Header
A header item that can be used to add som context for the user. Maybe a story line, or some explanation on why they should
complete the achievements.
```JSON
{
"id": 1,
"header": "Welcome to the book of achievements",
"description": "This is a subsection for the header and completely optional"
}
```
###### `id` - required
The `id` is required to be a **unique number** for every page item, as this identifies them later. The order is not important,
they just have to be unique.
###### `header` - required
The text that you would like to see as bold, and centered on the page
###### `description` - optional
A text that is italic, aligned left and fits right under the header
##### Text
You can of course add non-fancy text anywhere
```JSON
{
"id": 2,
"description": "Another element, this time only with text"
}
```
###### `id` - required
The `id` is required to be a **unique number** for every page item, as this identifies them later. The order is not important,
they just have to be unique.
###### `description` - required
A text that is italic, aligned left
##### Achievement
Adding achievements is no different
```JSON
{
"id": 3,
"achievement": "Carefully read the documentation",
"mod": "Achievement Books"
}
```
###### `id` - required
The `id` is required to be a **unique number** for every page item, as this identifies them later. The order is not important,
they just have to be unique.
###### `achievement` - required
The achievement text. Keep it short and concise if you want to make it look good. #protip
###### `mod` - optional
An extra information for the player, if the achievement is targeting a specific mod. This shows up in brackets and in blue
#### Example
```JSON
{
"itemName": "book_example",
"bookName": "Achievement Book Demo",
"color": "black",
"craftingMaterial": "minecraft:cobblestone",
"pages": [
[
{
"id": 1,
"header": "Welcome to the Achievement Book Demo2",
"description": "This book is only here to show you the capabilities of this mod\n"
},
{
"id": 2,
"description": "You can define a texts, headers and achievements in the config/achievementbooks folder"
}
],
[
{
"id": 3,
"header": "Getting to know the config"
},
{
"id": 5,
"achievement": "Craft the Achievement Book Demo book",
"mod": "vanilla"
},
{
"id": 4,
"achievement": "Check out the demo config file for the Achievement Books Mod",
"mod": "Achievement Books"
},
{
"id": 6,
"achievement": "Add a new achievement to the Achievement Book Demo",
"mod": "Achievement Books"
}
],
[
{
"id": 7,
"header": "Advanced Topics"
},
{
"id": 8,
"achievement": "Create another achievement book next to the Achievement Book Demo",
"mod": "Achievement Books"
},
{
"id": 9,
"achievement": "Change the wording of achievement id 4 in the Achievement Book Demo",
"mod": "Achievement Books"
},
{
"id": 10,
"achievement": "Reorder the achievements on page 2 of the Achievement Book Demo",
"mod": "Achievement Books"
}
]
]
}
```