Skip to content

Commit

Permalink
Merge pull request #31 from Dev0Louis/better-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Dev0Louis authored Jan 22, 2024
2 parents 37503bd + 8643644 commit 77b58ac
Showing 1 changed file with 29 additions and 7 deletions.
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,36 @@
# Nebula
Nebula is a Library for Mods that want to implement Spells.
It's a Library for creating Spells in all sorts of ways. Nebula adds Spell, Mana adds Client Syncing. <br>
If you consider Nebula or are stuck on anything feel free to reach out to me on my [Discord Server](https://discord.gg/r4nxHRcrZw). <br>
If you want full control you can override the SpellManager or ManaManagers!
With that you can basically change everything!<br> <b><sub>*Only one Mod can override a Manager.*</b></sub>

Or something different. The Mod aims to be very flexible so it is easy to work with.

It is important, that Nebula is still in Beta, so things will/might change.
You can include Nebula in your **build.gradle**:

```gradle
repositories {
exclusiveContent {
forRepository {
maven {
name = "Modrinth"
url = "https://api.modrinth.com/maven"
}
}
filter {
includeGroup "maven.modrinth"
}
}
}
dependencies {
modImplementation "maven.modrinth:nebula:4.0.3"
}
```
# Tutorial
## Creating your first Spell
You can see the [Nebulo Test mod](https://github.com/Dev0Louis/Nebula/tree/master/nebulo), it does implement a Spell and shows you how to override the Managers.

If you need any further help reach out to me on [Discord](https://discord.gg/9m5xv3qcdt)
<details><summary>Old</summary>

```java
public class SuicideSpell extends Spell {
public SuicideSpell(SpellType<? extends Spell> spellType, PlayerEntity caster) {
Expand All @@ -25,5 +48,4 @@ public class SuicideSpell extends Spell {
public static SpellType<SuicideSpell> SUICIDE = SpellType.register(new Identifier("yourmod", "suicide"), SpellType.Builder.create(SuicideSpell::new, 1));
```
We registered the Spell you need to replace "yourmod" with your modId. The Spell costs 1 Mana.

## More to be added.
</details>

0 comments on commit 77b58ac

Please sign in to comment.