Skip to content

Commit

Permalink
[skip actions] Renamed staging build display name
Browse files Browse the repository at this point in the history
Added build badge because more badges == fancier
Minor changes to the readme, I'll change it more in the future,
  • Loading branch information
juanmuscaria committed May 23, 2023
1 parent d074e26 commit a223cb4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/staging-build.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Release pre-release build
name: Pre-release build

on:
push:
Expand Down
37 changes: 15 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,25 @@
![](https://img.shields.io/badge/Bukkit--1.7.9--R0.3--SNAPSHOT-orange?style=flat-square)
![](https://img.shields.io/badge/Java%20JDK-v1.8-blue?style=flat-square)
![](https://img.shields.io/github/v/release/CrucibleMC/Crucible?color=sucess&style=flat-square)
![](https://img.shields.io/github/actions/workflow/status/CrucibleMC/Crucible/staging-build.yml?style=flat-square)
![](https://img.shields.io/discord/682358465175355393?color=blue&label=Discord&logo=Discord&style=flat-square)
![Crucible](logo.png)
### What's Crucible?

Crucible is a continuation of [Thermos](https://github.com/CyberdyneCC/Thermos) as it has been discontinued.
Crucible is a [Thermos](https://github.com/CyberdyneCC/Thermos) with several improvements.
We aim to close the gaps left by Thermos and extend the support for those still on 1.7.10 by adding support for long
broken mods and plugins and fix serious bugs as they appear.

Advantages over Thermos:
+ It is now possible to build. :)
+ Fixed several bugs.
+ Performance Improvements.
+ Updated some libraries.
+ Works with luckperms out of the box. No need to replace files!
+ TimingsV2 implemented.
+ Working/stable build across systems
+ Fixed several bugs
+ Performance Improvements
+ Updated some libraries
+ TimingsV2 implemented
+ You can see more changes in the [releases](https://github.com/CrucibleMC/Crucible/releases) changelog.

## Build Requirements
* Java 8u141 JDK or higher
* Linux (apparently the project breaks on Windows).
* Java 8 JDK
* `JAVA_HOME` defined on your OS

## Setup the Workspace
Expand All @@ -32,23 +33,15 @@ Advantages over Thermos:
* To create the patches with the changes made just run: `./gradlew genPatches`
* Building
* Before you can build you must first setup the workspace!
* To build just run the command: `./gradlew jar`
* All builds will be in `build/distributions`
* To build the distribution packages run the command: `./gradlew buildPackages`
* The distribution package will be in `build/distributions`
* Updating sources
* Update sources: `git pull origin master`
* Recreate the workspace: `./gradlew clean setupCrucible`
## Know incompatibilities and bugs
* Some coremods may crash with `java.lang.VerifyError: Expecting a stackmap frame`, we still don't know what causes that, but adding -noverify to your JVM arguments seems to fix the problem.

## Useful links
+ [Spark](https://github.com/lucko/spark) "Spark is a performance profiling plugin based on sk89q's WarmRoast profiler."
+ [Grimoire](https://github.com/CrucibleMC/Grimoire) "A core mod that [Grimoire-Mixins](https://github.com/CrucibleMC/Grimoire-Mixins) Modules use to be loaded up."
+ [Discord](https://discord.gg/jWSTJ4d) "Our support Discord."
+ [Crucible Documentation](https://cruciblemc.github.io/docs/) - Place for everything about crucible.
+ [Discord](https://discord.gg/jWSTJ4d) - Join our support discord if you need help with server setup, or if you just want to hang out.

## Roadmap
You can check our Roadmap on our [wiki](https://github.com/CrucibleMC/Crucible/wiki/Roadmap).

[forge]: https://img.shields.io/badge/Minecraft%20Forge-v10.13.4.1614-green.svg "Minecraft Forge v10.13.4.1614"
[mc]: https://img.shields.io/badge/Minecraft-v1.7.10-green.svg "Minecraft 1.7.10"
[java]: https://img.shields.io/badge/Java%20JDK-v1.8-blue.svg "Java JDK 8"
[spigot]: https://img.shields.io/badge/Spigot-v1.7.10--R0.1--SNAPSHOT-lightgrey.svg "Spigot R0.1 Snapshot"
You can check our Roadmap on our [docs](https://cruciblemc.github.io/docs/crucible/roadmap).

0 comments on commit a223cb4

Please sign in to comment.