Skip to content

Commit

Permalink
docs: update links and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ishland committed Aug 10, 2024
1 parent 53c9b2c commit a37b631
Show file tree
Hide file tree
Showing 21 changed files with 29 additions and 38 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![Github-CI](https://github.com/RelativityMC/C2ME-fabric/workflows/C2ME%20Build%20Script/badge.svg)](https://github.com/RelativityMC/C2ME-fabric/actions?query=workflow%3ACI)
[![Build Status](https://ci.codemc.io/job/RelativityMC/job/C2ME-fabric/job/ver%252F1.18/badge/icon)](https://ci.codemc.io/job/RelativityMC/job/C2ME-fabric/job/ver%252F1.18/)
[![Discord](https://img.shields.io/discord/756715786747248641?logo=discord&logoColor=white)](https://discord.io/ishlandbukkit)
[![Discord](https://img.shields.io/discord/756715786747248641?logo=discord&logoColor=white)](https://discord.gg/Kdy8NM5HW4)
<h3>A Fabric mod designed to improve the chunk performance of Minecraft.</h3>
</div>

Expand All @@ -19,30 +19,21 @@ Concurrent chunk management engine, it's about making the game better threaded a
Although it is usable in most cases and tested during build time, it doesn't mean that it is fully stable for a production server.
So backup your worlds and practice good game modding skills.

## Branch development status
| Branch | Status |
|-------------------|--------------------------------------|
| fabric/ver/1.20.1 | Active, Mainline |
| fabric/ver/1.19.4 | Bugfixes only |
| fabric/ver/1.18 | Bugfixes only |


## Downloads
You can find semi-stable releases here: https://github.com/RelativityMC/C2ME-fabric/releases

### Development builds
**Note: Development builds may modify the config files in a way unreadable by previous versions. You may encounter crashes or config reset when rolling back to previous versions. Please always backup your config.**
Modrinth: https://modrinth.com/mod/c2me-fabric
CurseForge: https://www.curseforge.com/minecraft/mc-mods/c2me-fabric

You can find development builds here: https://ci.codemc.io/job/RelativityMC/job/C2ME-fabric
Note that these builds may contain more bugfixes and performance improvements but are less tested.
If you have encountered any problems in release builds, give development builds a try before reporting.
## Support status for Minecraft versions
Only the latest Minecraft release and the latest Minecraft snapshot are fully supported.
Older Minecraft releases are in long-term support and will receive critical bug fixes.
Older Minecraft snapshots are not supported.

## Support
Our issue tracker: [link](https://github.com/RelativityMC/C2ME-fabric/issues)
Our discord server: [link](https://discord.io/ishlandbukkit)
Our discord server: [link](https://discord.gg/Kdy8NM5HW4)

## Building and setting up
JDK 17+ is required to build and use C2ME
JDK 21+ is required to build and use C2ME
Run the following commands in the root directory:

```shell
Expand Down
2 changes: 1 addition & 1 deletion c2me-base/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-client-uncapvd/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-notickvd/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-opts-allocs/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-opts-chunk-access/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-opts-chunkio/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-opts-math/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-opts-scheduling/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-rewrites-chunkio/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-server-utils/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion c2me-threading-lighting/src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/fabric.mod.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"contact": {
"sources": "https://github.com/RelativityMC/C2ME-fabric",
"issues": "https://github.com/RelativityMC/C2ME-fabric/issues",
"discord": "https://discord.io/ishlandbukkit",
"discord": "https://discord.gg/Kdy8NM5HW4",
"homepage": "https://modrinth.com/mod/c2me-fabric"
},
"license": "MIT",
Expand Down

0 comments on commit a37b631

Please sign in to comment.