From 5148f2de553b91d7ce48ad1561de4ff225502b00 Mon Sep 17 00:00:00 2001 From: bea4dev Date: Thu, 25 Jul 2024 22:35:05 +0900 Subject: [PATCH] edit README.md --- README.md | 79 ++++++++++++++++++++++++++----------------------------- 1 file changed, 38 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 5002de4..7a96349 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,38 @@ -# ForkTest - A Paper fork, using paperweight - -This is an example project, showcasing how to setup a fork of Paper (or any other fork using paperweight), using paperweight. - -The files of most interest are -- build.gradle.kts -- settings.gradle.kts -- gradle.properties - -When updating upstream, be sure to keep the dependencies noted in `build.gradle.kts` in sync with upstream. -It's also a good idea to use the same version of the Gradle wrapper as upstream. - -## Tasks - -``` -Paperweight tasks ------------------ -applyApiPatches -applyPatches -applyServerPatches -cleanCache - Delete the project setup cache and task outputs. -createMojmapBundlerJar - Build a runnable bundler jar -createMojmapPaperclipJar - Build a runnable paperclip jar -createReobfBundlerJar - Build a runnable bundler jar -createReobfPaperclipJar - Build a runnable paperclip jar -generateDevelopmentBundle -rebuildApiPatches -rebuildPatches -rebuildServerPatches -reobfJar - Re-obfuscate the built jar to obf mappings -runDev - Spin up a non-relocated Mojang-mapped test server -runReobf - Spin up a test server from the reobfJar output jar -runShadow - Spin up a test server from the shadowJar archiveFile -``` - -## Branches - -Each branch of this project represents an example: - - - [`main` is the standard example](https://github.com/PaperMC/paperweight-examples/tree/main) - - [`submodules` shows how paperweight can be applied on a fork using the more traditional git submodule system](https://github.com/PaperMC/paperweight-examples/tree/submodules) +![chiyogami](https://user-images.githubusercontent.com/34712108/135766838-98102b74-0990-4408-af3d-d576edb0b8fb.png) + +Chiyogamiは [Paper](https://github.com/PaperMC/Paper) をフォークしたものであり、Spigotプラグインを動作させつつマルチスレッド実行を可能とするMinecraftサーバーソフトです。 + +[![Support Server](https://img.shields.io/discord/893173646728757268.svg?label=Discord&logo=Discord&colorB=7289da&style=for-the-badge)](https://discord.com/invite/KKQNAPsFR6) + +> [Download](https://github.com/bea4dev/Chiyogami/releases) + +Other versions +------ +* [1.20.2](https://github.com/bea4dev/Chiyogami/tree/ver/1.20.2) +* [1.19.2](https://github.com/bea4dev/Chiyogami/tree/ver/1.19.2) + +Notes +------ +- [x] このサーバーは開発段階であるため十分なテストがされていません +- [x] このサーバーを実行する前には必ずワールドデータ等のバックアップをしてください +- [x] issue等のフィードバックを歓迎します + +API +------ +APIは未公開です + +How to build +------ + +ビルドを実行するには、git, jdk21が必要です。 + +1. リポジトリを [ダウンロード](https://codeload.github.com/bea4dev/Chiyogami/zip/refs/heads/ver/1.21) or clone して解凍します。 +2. 解凍したフォルダ内でWindowsの場合はgit-bash、linux or Macの場合はターミナルを開き```./gradlew applyPatches```を実行したあと```./gradlew createReobfBundlerJar```を実行します +3. ```build/libs```内にjarファイルが生成されていれば成功です + +For developer +------ + +このサーバーはワールドにそれぞれ専用のスレッドを割り当て、楽観的に同期を取りつつ動作します。 + +イベントの発火処理にはデフォルトで排他制御が設けられますが、ワールド間での順序関係は保証されないため注意が必要です。 \ No newline at end of file