Grasscutter README

The project's README from github.com/Grasscutters/Grasscutter. As one markdown file: README.md.

Grasscutter

Documentation GitHub release (latest by date) GitHub GitHub last commit GitHub Workflow Status
Discord - Grasscutter

EN | 简中 | 繁中 | FR | ES | HE | RU | PL | ID | KR | FIL/PH | NL | JP | IT | VI

Attention: We always welcome contributors to the project. Before adding your contribution, please carefully read our Code of Conduct.

Current features

Foreward

Grasscutter beyond the latest release will have no handholding in terms of instructions.

Grasscutter has not been actively maintained and currently (as of January 12th, 2025) only works up to version REL4.0.1 (introduction to Fontaine). If you have a beta version/unofficial version of Grasscutter, this guide should theoretically still work, however, we will not provide official support these versions. You can still try your luck in the Discord if you are stuck, but please don't act entitled.

Quick setup guide

Note: For support please join our Discord.

Quick Start (automatic)

Building

Grasscutter uses Gradle to handle dependencies & building.

Requirements:

Clone
git clone --recurse-submodules https://github.com/Grasscutters/Grasscutter.git
cd Grasscutter
Compile

Note: Handbook generation may fail on some systems. To disable the handbook generation, append -PskipHandbook=1 to the gradlew jar command.

Windows:

.\gradlew.bat # Setting up environments
.\gradlew jar

Linux (GNU):

chmod +x gradlew
./gradlew jar
Compiling the Handbook (Manually)

With Gradle:

./gradlew generateHandbook

With NPM:

cd src/handbook
npm install
npm run build

You can find the output jar in the root of the project folder.

Troubleshooting

For a list of common issues and solutions and to ask for help, please join our Discord server and go to the support channel.

Grasscutter (Grasscutters/Grasscutter)

Searching Database…

这是什么?Grasscutter 是某款动漫游戏的私服服务端软件重制版:你可以搭建自己的私人游戏服务器,并用游戏自带的客户端连上去玩。
这是游戏本身,还是只是游戏连接的服务器?只是服务端这一半。你仍然需要一个真正的 REL4.0.x 游戏客户端;Cultivation 启动器会把你现有的游戏安装指向服务器。
我怎么才能把私服搭起来?最简单的路径:安装 Java 17 和 MongoDB,准备好一个 REL4.0.x 客户端,然后用 Cultivation 启动器(.msi,以管理员身份运行)——设置好游戏和 Java 的路径,点启动即可。你也可以用 Gradle 自己编译服务端 jar(需要 JDK 17+ 和 Git)。
运行之前需要先装好哪些东西?Java 17、MongoDB Community Server,以及一个版本对应的 4.0.x 游戏客户端。版本不能混用——你必须下载和自己客户端版本匹配的 Grasscutter 版本。
它能配合最新版的游戏用吗?不能。该项目已停止积极维护,截至 2025 年 1 月 12 日,只支持到 REL4.0.1(枫丹更新)及之前的游戏版本。
它只能在 Windows 上用吗,还是服务器也能架在 Linux 上?服务端在 Windows 和 GNU/Linux 上都能编译运行,仓库还提供了 Docker 支持。只有客户端那一侧的 Cultivation 启动器是 Windows 的 .msi。
服务器跑起来之后,游戏里哪些功能实际可用?登录、战斗、好友列表、传送、祈愿抽卡系统、通过服务器控制台刷怪,以及背包功能(获取和升级物品、角色)都能用;联机只能部分使用。
登录时需要注册账号吗?不需要。用户名随便填,密码随便输什么都行。
可以用 Docker 跑服务器吗?可以——仓库在标准 Java/Gradle 方式之外还提供了 Docker 支持,所以服务器可以以容器方式运行,而不是直接跑一个 Java 进程。
What are similar projects?gost, mongo, Chat2DB, flyway, spider-flow, chat, Signal-Server, dtm
Size
99.1 MB
Stars
16.8K
Age
4y
Commits · 90 Days