Hereโs the Getting Started guide translated into English while maintaining its structure and tone:
Getting Started โ
Welcome, modders! ๐
We currently categorize modding into two main fields and provide various tools and tutorials to make the modding process easier.
- Client Modification Modding: Creating or modifying plugins for the Unity client that runs the actual game.
- Third-Party Application Modding: Creating websites or applications.
Additionally, you can create CLI tools or API services, which can also be developed using the tools and libraries provided for the second category.
Tutorials โ
We provide detailed tutorials for each field. If youโre ready to start, check out the links below:
- If you want to create a mod that does not require user signatures, refer to the Avatar Information Page Guide.
- If you want to create a mod that requires user signatures, check out the Daily Reward Page Guide.
- For client modding, refer to the BepInEx Guide.
INFO
A signature is required for creating transactions that need user authorization.
For example, when users purchase items from the Market or engage in adventures, a signature is necessary.
Third-Party Application Modding โ
Building websites or mobile applications is also considered modding by our standards.
To facilitate this process, weโve developed tools like Mimir and Chrono, and you can use various TypeScript libraries to develop your applications.
- Mimir: Access real-time game data via GraphQL, such as Arena rankings or avatar information. Check out the guide here.
- Chrono: A Chrome extension that provides wallet functionality for Nine Chronicles, similar to Metamask. See the guide here.
By using Mimir to retrieve data and Chrono to send transactions to the network, modding becomes much simpler. Since Mimir is a GraphQL service, it can also be used in CLI tools or analytics services.
- If you want to create a mod that doesnโt require user signatures, refer to the Avatar Information Page Tutorial.
- If you need to create a mod that requires signatures, refer to the Daily Reward Page Tutorial.
We also offer several TypeScript libraries. Check out the guide here.
Client Modding โ
Client modding can be divided into two main methods:
- Modding by downloading and modifying the client source code from the Nine Chronicles repository.
- Modding without directly modifying the client by developing plugins.
We recommend the second method since the client code is regularly updated, making it challenging to maintain modifications over time.
Although we havenโt prepared a guide for the first method yet, we recommend using BepInEx for plugin-based modding. BepInEx allows you to create mods as plugins without modifying the client directly, and users can easily install these plugins without needing to download a new client.
Both methods rely heavily on the necoyume.dll used within the game client. Therefore, itโs crucial to understand the APIs in the necoyume module.
Unfortunately, we donโt have a dedicated guide for this yet ๐ข, but you can refer to our Mods repository for examples of how mods are implemented. For more extensive usage, check the Nine Chronicles repository directly.
We have prepared a simple guide on how to call a notification from the necoyume module and install BepInEx. Check out the BepInEx Guide.
awesome-9c โ
awesome-9c is a repository that collects mods and services created by users. If youโve created a mod, feel free to submit a pull request and add your mod to the repository!
TIP
The next document is a system guide. If youโre looking for tutorials, please refer to the tutorial links provided in this document.
The following section includes basic guides that will help you during modding.
This version retains the technical depth and clarity, ensuring that both beginner and advanced developers can follow the process easily. Let me know if you need further adjustments!