Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maestro-denery authored Apr 4, 2023
1 parent 9e50db5 commit b9efee8
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,24 @@ Highly WIP. The Fabric Loader on top of Paper is implemented, see `toki-test-mod
See TODOs / Plans for more info about the state.

## Q & A
Q: Will my fabric mod `X` work on it?
Q: Will my fabric mod `X` work on it? \
A: No, as far as mod developer didn't port their mod on this platform.

Q: Why it doesn't allow to launch already existing Fabric mods?
Q: Why it doesn't allow to launch already existing Fabric mods? \
A: It is so unlikely that already exisiting mods will work, Paper makes so many changes so they break mods. (Though, if you are a developer and you have knowledge of mapping generation, you can discuss adding remapping of mods from intermediary to spigot as an experimental feature in this project.)

## How to build
Generally, the build process the same as Paper's, except you also need to run `./gradlew applyFabricLoaderPatches` and `./gradlew applyPaperclipPatches`.
```
git clone https://github.com/TetraTau/Toki.git
./gradlew applyPatches
./gradlew applyFabricLoaderPatches
./gradlew applyPaperclipPatches
For producion: (spigot mappings)
./gradlew createReobfPaperclipJar
For testing: (mojang mappings)
./gradlew createMojmapBundlerJar
```
## TODOs / Plans
- [x] Implement Fabric Loader on top of Paper.
- [ ] Create a Loom fork which supports patched Paper server source.
Expand Down

0 comments on commit b9efee8

Please sign in to comment.