Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AltronMaxX committed Aug 20, 2024
1 parent a651f03 commit d6d100d
Showing 1 changed file with 24 additions and 43 deletions.
67 changes: 24 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,58 +9,28 @@

[Folia region logic](https://docs.papermc.io/folia/reference/region-logic)

## Foldenor api
## Features
- **Bukkit Plugins Support!** Just add folia-supported: true at the end of any plugin.yml.
- **Various patches** blending from [other forks](https://github.com/Edenor-Minecraft/Foldenor?tab=readme-ov-file#credits).
- **Better Region Format** Support for the Linear region file format from [LinearPurpur](https://github.com/StupidCraft/LinearPurpur)
- ...

# How to use
## Downloads

[Gradle](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry#using-a-published-package)
Pre-built Jars can be found in the [Releases Tab](https://github.com/Edenor-Minecraft/Foldenor/releases/)

[Maven](https://docs.github.com/ru/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#installing-a-package)
## Building

# Maven
Building a Paperclip JAR for distribution:

Artifact Information:

<dependency>
<groupId>dev.edenor.foldenor</groupId>
<artifactId>foldenor-api</artifactId>
<version>1.20.4-R0.1-SNAPSHOT</version>
</dependency>

# Gradle

Gradle Repo (for foldenor-api):

maven {
url = uri("https://maven.pkg.github.com/Edenor-Minecraft/Foldenor/")
credentials {
username = System.getenv("USERNAME")
password = System.getenv("TOKEN")
}
}

Artifact Information:

dependencies {
compileOnly 'dev.edenor.foldenor:foldenor-api:1.20.4-R0.1-SNAPSHOT'
}
```bash
./gradlew applyPatches && ./gradlew createMojmapPaperclipJar
```

## About Edenor
[VK](https://vk.com/edenorrp)

[Discord](https://discord.gg/bC66Pwh)

[Telegram](https://t.me/edenorrp)

[Website](https://edenor.ru/)

## Communication with the developer
[VK](https://vk.com/altronmaxx)

[Discord](https://discord.com/users/324794944042565643)

[GitHub](https://github.com/AltronMaxX)

[Telegram](https://t.me/AltronMaxX)

## License
Expand All @@ -71,4 +41,15 @@ The fork is based off of PaperMC's fork example found [here](https://github.com/
As such, it contains modifications to it in this project, please see the repository for license information
of modified files.


## Credits
Thanks to these projects below. Foldenor just mix some of their patches together.<br>
If these excellent projects hadn't appeared, Foldenor wouldn't have become great.

- [Purpur](https://github.com/PurpurMC/Purpur)
- [Leaf](https://github.com/Winds-Studio/Leaf)
- [Pufferfish](https://github.com/pufferfish-gg/Pufferfish)
- [Gale](https://github.com/GaleMC/Gale)
- [ShreddedPaper](https://github.com/MultiPaper/ShreddedPaper)
- [Leaves](https://github.com/LeavesMC/Leaves)
- [Kaiiju](https://github.com/KaiijuMC/Kaiiju)
- [SparklyPaper](https://github.com/SparklyPower/SparklyPaper)

0 comments on commit d6d100d

Please sign in to comment.