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 и нажмите запуск. Можно также собрать серверный jar самостоятельно через Gradle (нужны JDK 17+ и Git).
Что должно быть установлено, чтобы всё это запустилось?Java 17, MongoDB Community Server и подходящий клиент игры 4.0.x. Версии смешивать нельзя — нужно скачать сборку Grasscutter, которая соответствует версии вашего клиента.
Будет ли это работать с последней версией игры?Нет. Проект больше активно не поддерживается и по состоянию на 12 января 2025 года работает только с версиями игры до REL4.0.1 (обновление Фонтэйна).
Это только для Windows или сервер можно поднять и на Linux?Сервер собирается и работает и на Windows, и на GNU/Linux, а в репозитории есть поддержка Docker. Под Windows выполнен только лаунчер Cultivation для клиента — это .msi.
Что реально работает в игре после запуска сервера?Работают вход в игру, бои, список друзей, телепортация, гача-система, спавн монстров через консоль сервера и инвентарь (получение и прокачка предметов и персонажей); кооператив работает лишь частично.
Нужно ли регистрировать аккаунт для входа?Нет. Логин можно указать любой, а пароль — какой угодно.
Можно ли запустить сервер в Docker?Да — в репозитории есть поддержка Docker наряду с обычным вариантом на Java/Gradle, так что сервер может работать как контейнер вместо обычного 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