68 lines
4.1 KiB
Markdown
68 lines
4.1 KiB
Markdown
<div align="center">
|
|
<img src="https://i.imgur.com/zTCTCWG.png" alt="Magma logo" align="middle"></img>
|
|
|
|
[](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.20.1.html)
|
|
[](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/bukkit/browse)
|
|
[](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/craftbukkit/browse?at=refs%2Fheads%2Fversion%2F1.20)
|
|
[](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/spigot/browse)
|
|
<!--  -->
|
|
[](https://discord.gg/magma)
|
|
|
|
<a href="https://bstats.org/plugin/server-implementation/Magma/17219"> <img src="https://bstats.org/signatures/server-implementation/Magma.svg" alt="Stats" width="800"></a>
|
|
</div>
|
|
|
|
## ❓ About
|
|
|
|
Magma is the next generation of hybrid minecraft server softwares.
|
|
|
|
Magma is based on **Forge and Paper**, meaning it can run both **Craftbukkit/Spigot/Paper plugins and Forge mods**.
|
|
|
|
We hope to eliminate all issues with craftbukkit forge servers. In the end, we envision a seamless, low lag Magma experience with support for newer 1.12+ versions of Minecraft.
|
|
|
|
## 🌐 BungeeCord/Velocity
|
|
|
|
Magma 1.20 is **not** compatible with **vanilla** BungeeCord or any of its forks. This is **caused by Forge** and not a fault of Magma. We cannot fix this ourselves without modifying the client.
|
|
You might be able to use the Waterfall fork called [Lightfall](https://github.com/ArclightPowered/lightfall), but it also requires a clientside-mod in order to work and is not officially supported.
|
|
|
|
Magma 1.20 is **not** compatible with **vanilla** [Velocity](https://velocitypowered.com/downloads/). This is **caused by Forge** and not a fault of Magma. We cannot fix this ourselves without modifying the client and the proxy.
|
|
|
|
## 🪣 Deployment
|
|
|
|
### Installation
|
|
|
|
1. Download the recommended builds from the [**Releases** section](https://git.magmafoundation.org/magmafoundation/Magma-1-20-x/-/releases) (**Download** the one that ends in server)
|
|
1. Or Download the latest jar from [Magma Site](https://magmafoundation.org/)
|
|
2. Make a new directory (folder) for the server
|
|
3. Move the jar that you downloaded into the new directory
|
|
4. Run the jar with your command prompt or terminal, going to your directory and entering `java -jar Magma-[version]-server.jar`. Change [version] to your Magma version number.
|
|
|
|
### Building the sources
|
|
|
|
- Clone the Project
|
|
- You can use Git GUI (like GitHub Desktop/GitKraken) or clone using the terminal using:
|
|
- `git clone http://git.magmafoundation.org/magmafoundation/Magma-1-20-x.git`
|
|
- Building
|
|
- First you want to run the build command
|
|
- `./gradlew setup magmaJar`
|
|
- Now go and get a drink this may take some time
|
|
- Navigate to `projects/magma/build/libs` directory of the compiled source code
|
|
- Copy the Jar to a new server directory (see Installation)
|
|
|
|
## ⚙️ Contributing
|
|
|
|
If you wish to inspect Magma, submit PRs, or otherwise work with Magma itself, you're in the right place!.
|
|
|
|
Please read the [CONTRIBUTING.md](https://git.magmafoundation.org/magmafoundation/Magma-1-20-x/-/blob/1.20/CONTRIBUTING.md) to see how to contribute, setup, and run.
|
|
|
|
## 💬 Chat
|
|
|
|
You are welcome to visit Magma's Discord server [here](https://discord.gg/Magma) (recommended).
|
|
|
|
You could also go to Magma's subreddit [here](https://www.reddit.com/r/Magma).
|
|
|
|
## 👥 Partners
|
|
|
|
|
|
|
|
[YourKit](http://www.yourkit.com/), makers of the outstanding java profiler, support open source projects of all kinds with their full featured [Java](https://www.yourkit.com/java/profiler/index.jsp) and [.NET](https://www.yourkit.com/.net/profiler/index.jsp) application profilers.
|
|
|