Skip to content

Commit

Permalink
[skip ci] Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TonimatasDEV committed Nov 22, 2023
1 parent 5a83c5f commit a3cfd44
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 262 deletions.
46 changes: 20 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,40 @@
<div align="center">
<img src="https://i.imgur.com/zTCTCWG.png" alt="Magma logo" align="middle"></img>

[![](https://img.shields.io/badge/Minecraft%20Forge-1.18.2%20--%2040.2.10%20--%209523232-orange.svg)](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.18.2.html)
[![](https://img.shields.io/badge/Bukkit-1.18%20r2-blue)](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/bukkit/browse)
[![](https://img.shields.io/badge/CraftBukkit-Build%20b02801aa-orange)](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/craftbukkit/browse)
[![](https://img.shields.io/badge/Spigot-Build%20b0819150-yellow)](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/spigot/browse)
![TeamCity build status](https://teamcity.magmafoundation.org/app/rest/builds/buildType:id:MagmaFoundation_Magma118x_Build/statusIcon.svg)
[![](https://img.shields.io/discord/612695539729039411.svg?logo=discord&logoWidth=18&colorB=7289DA)](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>
[![](https://img.shields.io/badge/Minecraft%20Forge-1.20.1%20--%2047.2.0%20--%2012d24df4-orange.svg)](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.20.1.html)
[![](https://img.shields.io/badge/Bukkit-1.20%203635fe1-blue)](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/bukkit/browse)
[![](https://img.shields.io/badge/CraftBukkit-Build%2078796c9de6c-orange)](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/craftbukkit/browse?at=refs%2Fheads%2Fversion%2F1.20)
[![](https://img.shields.io/badge/Spigot-Build%20d2eba2c820b-yellow)](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/spigot/browse)

[![](https://img.shields.io/discord/1175785262475923556.svg?logo=discord&logoWidth=18&colorB=7289DA)](https://discord.gg/STZjCzRZn9)
</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.
Magma is based on **Forge and Spigot**, meaning it can run both **CraftBukkit/Spigot plugins and Forge mods**.

## 🌐 BungeeCord/Velocity

Magma 1.18 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.
Magma 1.18.2 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.

You can use **our [Velocity fork](https://git.magmafoundation.org/magmafoundation/Velocity)** with our [clientside mod](https://git.magmafoundation.org/magmafoundation/Forge-Client-Reset-Packet/-/tree/1.18). Every player needs to install this mod in order to join the server!

Magma 1.18 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.
Magma 1.18.2 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.

## 🧪 Magma for 1.12+/1.16+
## 🧪 Other versions

Magma for Minecraft 1.12 and above can be found in their own repositories.

- Click [here](https://git.magmafoundation.org/magmafoundation/Magma) to visit the 1.12 repository.
- Click [here](https://git.magmafoundation.org/magmafoundation/Magma-1-16-x) to visit the 1.16 repository. (1.16 is End Of Life and not actively maintained anymore)
- 1.19 Soon!
- For 1.20.2 use [Ketting](https://github.com/kettingpowered)
- For 1.20.1 [here](https://github.com/magmamaintained/Magma-1.20.1)
- For 1.19.3 [here](https://github.com/magmamaintained/Magma-1.19.3)
- For 1.12.2 [here](https://github.com/magmamaintained/Magma-1.12.2)

## 🪣 Deployment

### Installation

1. Download the recommended builds from the [**Releases** section](https://git.magmafoundation.org/magmafoundation/Magma-1-18-x/-/releases) (**Download** the one that ends in server)
1. Or Download the latest jar from [Magma Site](https://magmafoundation.org/)
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.
Expand All @@ -50,19 +43,19 @@ Magma for Minecraft 1.12 and above can be found in their own repositories.

- 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-18-x.git`
- `git clone https://github.com/TonimatasDEV/Magma-1.20.1.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-18-x/-/blob/1.18.x/CONTRIBUTING.md) to see how to contribute, setup, and run.
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

Expand All @@ -75,3 +68,4 @@ You could also go to Magma's subreddit [here](https://www.reddit.com/r/Magma).
![YourKit-Logo](https://www.yourkit.com/images/yklogo.png)

[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.

18 changes: 0 additions & 18 deletions docs/CONTRIBUTING.md

This file was deleted.

65 changes: 0 additions & 65 deletions docs/README.md

This file was deleted.

Loading

0 comments on commit a3cfd44

Please sign in to comment.