Skip to content

Commit 54879e8

Browse files
authored
Update README.md
1 parent 3cb98bc commit 54879e8

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

README.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,47 @@
11
Sakura
22
===========
3-
This is a fork of Paper to optimise cannoning intended for cannon and factions servers on modern versions.
3+
This is a fork of Paper to optimise cannoning and provide essential features for testing and faction servers.
44

5-
---
5+
There are branches from the latest version to 1.19.4. If you need a 1.8.8 server jar check out the project Sakura was based on [Blossom](https://github.com/Samsuik/Blossom).
66

7-
Initially this repository will be publicised with just some cannon optimisations.
8-
Later updates will bring feature parity with [Blossom](https://github.com/Samsuik/Blossom) and the private Sakura builds is planned.
7+
## There are compiled binaries on the releases page
98

9+
> https://github.com/Samsuik/Sakura/releases
10+
11+
## Requirements (Source, Compiling)
12+
13+
### Windows (you need [Git Bash](https://git-scm.com/download/win) and a JDK)
14+
> You can use command prompt on if Git is installed, make sure you to not include the `./` at the start of the gradlew commands.
15+
>
16+
> You may also have trouble with the file path length limit, there is a registry tweak you can make to remove this limitation.
17+
> - https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation
18+
19+
### Linux (git and a JDK)
20+
> ...
21+
22+
## Obtaining the source code
23+
> ```
24+
> git clone https://github.com/Samsuik/Sakura
25+
> ```
26+
> Navigate to the locally cloned sakura repository
27+
> ```
28+
> cd Sakura
29+
> ```
30+
> You can use `git checkout ...` to choose between branches.
31+
> ```
32+
> git checkout 1.20.6
33+
> ```
34+
> To get the source code you can view, make changes etc.
35+
> ```
36+
> ./gradlew applyPatches
37+
> ```
38+
39+
## Building the project
40+
> ### 1.20.4 and earlier
41+
> ```
42+
> ./gradlew createReobfPaperclipJar
43+
> ```
44+
> ### 1.20.6 and later
45+
> ```
46+
> ./gradlew createMojmapPaperclipJar
47+
> ```

0 commit comments

Comments
 (0)