diff --git a/mkdocs.yml b/mkdocs.yml index 84d10ac..09fe247 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ # Project information -site_name: Purpur Documentation +site_name: PurpurMC Documentation site_url: https://purpurmc.org/docs site_author: granny site_description: >- @@ -7,12 +7,28 @@ site_description: >- Purpur is a fork of Pufferfish (and by extension, Paper) with the goal of providing new and interesting configuration options, which allow for creating a unique gameplay experience not seen anywhere else. docs_dir: mkdocs nav: - - Home: index.md - - Installation: Installation.md - - Configuration: Configuration.md - - Commands: Commands.md - - Permissions: Permissions.md - - Frequently Asked Questions: FAQ.md + - index.md + - Purpur: + - Purpur: purpur/index.md + - Installation: purpur/installation.md + - Configuration: purpur/configuration.md + - Commands: purpur/commands.md + - Permissions: purpur/permissions.md + - Frequently Asked Questions: purpur/faq.md + - PurpurExtras: + - PurpurExtras: purpurextras/index.md + - Installation: purpurextras/installation.md + - Configuration: purpurextras/configuration.md + - Commands: purpurextras/commands.md + # - Permissions: purpurextras/permissions.md + # - Frequently Asked Questions: purpurextras/faq.md + - PurpurPacks: + - PurpurPacks: purpurpacks/index.md + # - Installation: purpurpacks/installation.md + # - Configuration: purpurpacks/configuration.md + # - Commands: purpurpacks/commands.md + # - Permissions: purpurpacks/permissions.md + # - Frequently Asked Questions: purpurpacks/faq.md repo_url: https://github.com/PurpurMC/PurpurDocs repo_name: PurpurDocs edit_uri: edit/main/mkdocs/ @@ -20,6 +36,7 @@ extra_css: - stylesheets/extra.css plugins: - search + - ezlinks - markdownextradata - autolink_references: autolinks: @@ -27,18 +44,27 @@ plugins: target_url: https://bugs.mojang.com/browse/MC- - redirects: redirect_maps: - 'commands.md': 'Commands.md' - 'cmds.md': 'Commands.md' - 'configuration.md': 'Configuration.md' - 'config.md': 'Configuration.md' - 'permissions.md': 'Permissions.md' - 'perms.md': 'Permissions.md' - 'faq.md': 'FAQ.md' + 'commands.md': 'purpur/commands.md' + 'cmds.md': 'purpur/commands.md' + 'configuration.md': 'purpur/configuration.md' + 'config.md': 'purpur/configuration.md' + 'permissions.md': 'purpur/permissions.md' + 'perms.md': 'purpur/permissions.md' + 'faq.md': 'purpur/faq.md' + 'Commands.md': 'purpur/commands.md' + 'Configuration.md': 'purpur/configuration.md' + 'FAQ.md': 'purpur/faq.md' + 'Installation.md': 'purpur/installation.md' + 'Log4j.md': 'purpur/log4j.md' + 'Permissions.md': 'purpur/permissions.md' theme: name: material custom_dir: overrides favicon: images/purpur-small.png logo: images/purpur-small.png + features: + - navigation.tabs + - navigation.indexes palette: - scheme: slate primary: light blue @@ -68,7 +94,12 @@ extra: build: number: 1976 commit: 68117a4e + purpur_extras: + downloads: https://modrinth.com/plugin/purpurextras/versions + source: https://github.com/PurpurMC/PurpurExtras social: - icon: fontawesome/brands/discord link: https://purpurmc.org/discord name: Purpur Discord Server + purpur_packs: + source: https://github.com/PurpurMC/PurpurPacks \ No newline at end of file diff --git a/mkdocs/Commands.md b/mkdocs/purpur/commands.md similarity index 95% rename from mkdocs/Commands.md rename to mkdocs/purpur/commands.md index 212ba37..57f9452 100644 --- a/mkdocs/Commands.md +++ b/mkdocs/purpur/commands.md @@ -43,7 +43,7 @@ Purpur adds a few new commands to the game. ## /demo ??? info "Image of the Demo Screen 📷" - ![Demo Screen](images/demo.png) + ![Demo Screen](demo.png) - This command shows the demo screen to players if you have the `bukkit.command.demo.other` permission. If you do not specify a player name or player entity selector (`@a`, `@r`, etc) it will show the demo screen to yourself. - **examples**: @@ -61,7 +61,7 @@ Purpur adds a few new commands to the game. ## /credits ??? info "Image of the Credits screen 📷" - ![Credits screen](images/credits.png) + ![Credits screen](credits.png) - This command shows the credits screen to players if you have the `bukkit.command.credits.other` permission. If you do not specify a player name or player entity selector (`@a`, `@r`, etc) it will show the credits screen to yourself. - **examples**: @@ -79,7 +79,7 @@ Purpur adds a few new commands to the game. ## /tpsbar ??? info "Image of the tpsbar in action 📷" - ![TPSBar in action](images/bossbar.gif) + ![TPSBar in action](bossbar.gif) - This command shows a bossbar showcasing your current TPS/MSPT to players if you have the `bukkit.command.tpsbar.other` permission. If you do not specify a player name or player entity selector (`@a`, `@r`, etc) it will show the tpsbar to yourself. - **examples**: @@ -97,7 +97,7 @@ Purpur adds a few new commands to the game. ## /compass ??? info "Image of the compass in action 📷" - ![Compass in action](images/bossbar.gif) + ![Compass in action](bossbar.gif) - This command shows a bossbar showcasing your current facing direction. - **examples** diff --git a/mkdocs/Configuration.md b/mkdocs/purpur/configuration.md similarity index 99% rename from mkdocs/Configuration.md rename to mkdocs/purpur/configuration.md index 3a02220..9249f19 100644 --- a/mkdocs/Configuration.md +++ b/mkdocs/purpur/configuration.md @@ -60,7 +60,7 @@ Global settings affect all worlds on the server as well as the core server funct - **description**: Output of `` placeholder in [command.uptime.format](#format) option * #### gamemode * ##### requires-specific-permission - - Requires [`minecraft.command.gamemode.`](../Permissions#minecraftcommandgamemodegamemode) permission + - Requires [`minecraft.command.gamemode.`](permissions#minecraftcommandgamemodegamemode) permission - **default**: false - **description**: Set to true for each gamemode to require its own permission * #### tpsbar @@ -155,7 +155,7 @@ Global settings affect all worlds on the server as well as the core server funct * ##### title - **default**: "S · ◈ · ◈ · ◈ · SW · ◈ · ◈ · ◈ · W · ◈ · ◈ · ◈ · NW · ◈ · ◈ · ◈ · N · ◈ · ◈ · ◈ · NE · ◈ · ◈ · ◈ · E · ◈ · ◈ · ◈ · SE · ◈ · ◈ · ◈ · S · ◈ · ◈ · ◈ · SW · ◈ · ◈ · ◈ · W · ◈ · ◈ · ◈ · NW · ◈ · ◈ · ◈ · N · ◈ · ◈ · ◈ · NE · ◈ · ◈ · ◈ · E · ◈ · ◈ · ◈ · SE · ◈ · ◈ · ◈ · " - - **description**: The format of the bossbar when the server runs the [`/compass`](../Commands#compass) command + - **description**: The format of the bossbar when the server runs the [`/compass`](commands#compass) command * ##### overlay - **default**: PROGRESS @@ -265,7 +265,7 @@ Requires the [`kick-if-idle`](#kick-if-idle) setting to be `false` - **description**: The suffix that shows up on the playerlist after someone's name when they're AFK #### cannot-ride-mob -Requires the [`allow.ride.`](../Permissions#allowridemob_id) permission +Requires the [`allow.ride.`](permissions#allowridemob_id) permission - **default**: <red>You cannot mount that mob - **description**: Message that shows when someone tries to mount a mob they're not allowed to. @@ -277,32 +277,32 @@ Requires the [`damage-if-sprinting`](#damage-if-sprinting) option to be enabled - **description**: Actionbar message that shows when someone attempts to run with scissors #### ping-command-output -Requires the [`bukkit.command.ping`](../Permissions#bukkitcommandping) permission +Requires the [`bukkit.command.ping`](permissions#bukkitcommandping) permission - **default**: <green>%s's ping is %sms - **description**: Output when `/ping ` is run. #### uptime-command-output -Requires the [`bukkit.command.uptime`](../Permissions#bukkitcommanduptime) permission +Requires the [`bukkit.command.uptime`](permissions#bukkitcommanduptime) permission `` - The format from [`.command.uptime.format`](#format) - **default**: <green>Server uptime is <uptime> - **description**: Message that shows when the `/uptime` command is ran. #### demo-command-output -Requires the [`bukkit.command.demo`](../Permissions#bukkitcommanddemo) permission +Requires the [`bukkit.command.demo`](permissions#bukkitcommanddemo) permission - **default**: <green>%s has been shown the demo screen - **description**: Message that shows when the demo screen is enabled for a user using the `/demo` command. #### credits-command-output -Requires the [`bukkit.command.credits`](../Permissions#bukkitcommandcredits) permission +Requires the [`bukkit.command.credits`](permissions#bukkitcommandcredits) permission - **default**: <green>%s has been shown the end credits - **description**: Message that shows when the credits screen is enabled for a user using the `/credits` command. #### tpsbar-command-output -Requires the [`bukkit.command.tpsbar`](../Permissions#bukkitcommandtpsbar) permission +Requires the [`bukkit.command.tpsbar`](permissions#bukkitcommandtpsbar) permission - **default**: <green>Tpsbar toggled <onoff> for <target> - **description**: Message that shows when the tpsbar is enabled for a user using the `/tpsbar` command. @@ -382,7 +382,7 @@ Requires the [`bukkit.command.tpsbar`](../Permissions#bukkitcommandtpsbar) permi - **description**: When enabled, ender chests should have six rows of inventory space * ##### use-permissions-for-rows - Requires [`ender_chest.six-rows`](#six-rows) to be true - - Requires [`purpur.enderchest.rows.`](../Permissions#purpurenderchestrowsnumber) permission + - Requires [`purpur.enderchest.rows.`](permissions#purpurenderchestrowsnumber) permission - **default**: false - **description**: Use permission nodes to determine the number of rows. By default, with this setting enabled, all players have `six` rows unless otherwise specified using permissions. @@ -725,7 +725,7 @@ For a more clear explanation of the world settings section of the config, feel f #### sign * ##### allow-colors - - Requires [`purpur.sign.color`](../Permissions#purpursigncolor), [`purpur.sign.style`](../Permissions#purpursignstyle), and/or [`purpur.sign.magic`](../Permissions#purpursignmagic) permission + - Requires [`purpur.sign.color`](permissions#purpursigncolor), [`purpur.sign.style`](permissions#purpursignstyle), and/or [`purpur.sign.magic`](permissions#purpursignmagic) permission - **default**: false - **description**: Allow players to use color codes on signs #### magma-block @@ -832,11 +832,11 @@ For a more clear explanation of the world settings section of the config, feel f - **description**: Allows anvils to be placed by dispensers #### anvil * ##### use-mini-message - - Requires [`purpur.anvil.minimessage`](../Permissions#purpuranvilminimessage) permission + - Requires [`purpur.anvil.minimessage`](permissions#purpuranvilminimessage) permission - **default**: false - **description**: Allows players to use MiniMessage tags in an anvil. * ##### allow-colors - - Requires [`purpur.anvil.color`](../Permissions#purpuranvilcolor) permission + - Requires [`purpur.anvil.color`](permissions#purpuranvilcolor) permission - **default**: false - **description**: Allows players to use color codes in anvils * ##### iron-ingots-used-for-repair @@ -3305,7 +3305,7 @@ based on the world difficulty. [Read more here]({{ project.source }}/blob/61fc0a - **default**: 0 - **description**: Disabled by default (0), Amount of ticks an entity will live before disappearing. Interacting with a player resets the timer #### silk-touch -Requires the [`purpur.drop.spawners`](../Permissions#purpurdropspawners) and [`purpur.place.spawners`](../Permissions#purpurplacespawners) permissions +Requires the [`purpur.drop.spawners`](permissions#purpurdropspawners) and [`purpur.place.spawners`](permissions#purpurplacespawners) permissions * ##### enabled - **default**: false @@ -3531,7 +3531,7 @@ Requires the [`purpur.drop.spawners`](../Permissions#purpurdropspawners) and [`p * ##### compass * ###### holding-shows-bossbar - **default**: false - - **description**: If the bossbar from the [`/compass`](../Commands#compass) command should show when holding a compass + - **description**: If the bossbar from the [`/compass`](commands#compass) command should show when holding a compass * ##### glow_berries * ###### eat-glow-duration - **default**: 0 diff --git a/mkdocs/FAQ.md b/mkdocs/purpur/faq.md similarity index 100% rename from mkdocs/FAQ.md rename to mkdocs/purpur/faq.md diff --git a/mkdocs/purpur/index.md b/mkdocs/purpur/index.md new file mode 100644 index 0000000..fc8a357 --- /dev/null +++ b/mkdocs/purpur/index.md @@ -0,0 +1,156 @@ +[![Purpur Image](https://user-images.githubusercontent.com/74448585/150906023-101cd383-da82-4a3c-9603-a3b5741c3994.png)]({{ project.website }}) + +
+ +[![MIT License](https://img.shields.io/github/license/PurpurMC/Purpur?&logo=github)](License)  +[![Github Actions Build](https://img.shields.io/github/workflow/status/purpurmc/purpur/Build?event=push&logo=github)]({{ project.downloads }}) +[![CodeFactor](https://www.codefactor.io/repository/github/purpurmc/purpur/badge)](https://www.codefactor.io/repository/github/purpurmc/purpur)  +[![Join us on Discord](https://img.shields.io/discord/685683385313919172.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)]({{ social[0].link }})  + +[![Purpur's Stargazers](https://img.shields.io/github/stars/PurpurMC/Purpur?label=stars&logo=github)]({{ project.source }}/stargazers)  +[![Purpur Forks](https://img.shields.io/github/forks/PurpurMC/Purpur?label=forks&logo=github)]({{ project.source }}/network/members)  +[![Purpur Watchers](https://img.shields.io/github/watchers/PurpurMC/Purpur?label=watchers&logo=github)]({{ project.source }}/watchers)  + +Welcome to the official documentation source for the [Purpur]({{ project.source }}/) project. + +This documentation is current to Build [#{{ project.build.number }}](https://api.purpurmc.org/v2/purpur/{{ project.version }}/{{ project.build.number }}/download) ([`{{ project.build.commit }}`]({{ project.source }}/commit/{{ project.build.commit }})) + +Purpur is a drop-in replacement for [Paper](https://github.com/PaperMC/Paper) servers that's designed for configurability, and new fun and exciting gameplay features. + +
+ +## Contact [![Discord shield.io](https://img.shields.io/discord/685683385313919172.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)]({{ social[0].link }}) + +Join us on [Discord]({{ social[0].link }})! + +## Downloads + +You can download Purpur from the [downloads page]({{ project.downloads }}) or the [downloads API](https://api.purpurmc.org/). + +Downloads API endpoints: + + * List versions of Minecraft with builds available: + `https://api.purpurmc.org/v2/purpur/` + * List builds for a version of Minecraft: + `https://api.purpurmc.org/v2/purpur/` + * Download a specific build of a specific version: + `https://api.purpurmc.org/v2/purpur///download` + * Download the latest build for a version of Minecraft: + `https://api.purpurmc.org/v2/purpur//latest/download` + +## License [![MIT License](https://img.shields.io/github/license/PurpurMC/Purpur?&logo=github)](./#license) + +This project licenses all patches under the MIT license, unless the patch headers note otherwise. + +See [PaperMC/Paper](https://github.com/PaperMC/Paper) for the license of material this project uses. + +## bStats + + + + +## API + +### Javadoc +You can find the Javadocs for Purpur at: {{ project.javadoc }} + +### Dependency Information +=== "Maven" + + ``` xml linenums="1" + + + + purpur + Purpur Maven Repo + https://repo.purpurmc.org/snapshots + + + + ``` + ``` xml linenums="1" + + + + org.purpurmc.purpur + purpur-api + {{ project.version }}-R0.1-SNAPSHOT + provided + + + + ``` + +=== "Gradle (Kotlin)" + + ``` kotlin linenums="1" + repositories { + //... other repos ...// + + //Add this somewhere after mavenCentral() + maven("https://repo.purpurmc.org/snapshots") + + //... other repos ...// + } + ``` + ``` kotlin linenums="1" + dependencies { + //... other dependencies ...// + + compileOnly("org.purpurmc.purpur", "purpur-api", "{{ project.version }}-R0.1-SNAPSHOT") + + //... other dependencies ...// + } + ``` + +=== "Gradle (Groovy)" + + ``` groovy linenums="1" + repositories { + //... other repos ...// + + //Add this somewhere after mavenCentral() + maven { + url "https://repo.purpurmc.org/snapshots" + } + + //... other repos ...// + } + ``` + ``` groovy linenums="1" + dependencies { + //... other dependencies ...// + + compileOnly "org.purpurmc.purpur:purpur-api:{{ project.version }}-R0.1-SNAPSHOT" + + //... other dependencies .../// + } + ``` + +Importing Purpur into your project also includes all APIs provided by Pufferfish, Paper, Spigot, and Bukkit. + +## Building and setting up + +#### Initial setup +Run the following command in the root of the project directory: + +``` bash linenums="1" +./gradlew applyPatches +``` + +#### Creating a patch +Patches are effectively just commits in either `Purpur-API` or `Purpur-Server`. +To create one, just add a commit to either repo and run `./gradlew rebuildPatches`, and Gradle will +place a patch in the patches folder. Modifying commits will also modify their +corresponding patch file(s). + +See [CONTRIBUTING.md]({{ project.source }}/blob/HEAD/CONTRIBUTING.md) for more detailed information. + + +#### Compiling + +Use the command `./gradlew build` to build the api and server. Gradle will place compiled jars + under `Purpur-API/build/libs` and `Purpur-Server/build/libs`. + +To get a purpurclip jar, run `./gradlew paperclip`. +To install the `purpur-api` and `purpur` dependencies to your local maven repo, run `./gradlew publishToMavenLocal` diff --git a/mkdocs/Installation.md b/mkdocs/purpur/installation.md similarity index 100% rename from mkdocs/Installation.md rename to mkdocs/purpur/installation.md diff --git a/mkdocs/Log4j.md b/mkdocs/purpur/log4j.md similarity index 100% rename from mkdocs/Log4j.md rename to mkdocs/purpur/log4j.md diff --git a/mkdocs/Permissions.md b/mkdocs/purpur/permissions.md similarity index 62% rename from mkdocs/Permissions.md rename to mkdocs/purpur/permissions.md index 8b26b6f..648e563 100644 --- a/mkdocs/Permissions.md +++ b/mkdocs/purpur/permissions.md @@ -3,7 +3,7 @@ Purpur adds a few new permission nodes for some of its added features. By default, Purpur disables **all** of these permissions, no matter if a user has OP. Servers will need a permissions plugin such as [LuckPerms](https://luckperms.net/) to grant permissions to users. ## allow.ride..ridable`](../Configuration#mobs) in purpur.yml +Requires enabling [`.ridable`](configuration#mobs) in purpur.yml - This permission gives the ability to ride a certain mob by shift right-clicking it. Once mounted you can use WASD to move around, and spacebar to jump or fly. Just replace ".ridable`](../Configuration#mobs) in purpur.yml +Requires enabling [`.ridable`](configuration#mobs) in purpur.yml - This permission gives the ability to activate a ridable mob's special ability. Not all mobs have a special ability. Just replace "` permission won't be targetted by that type of mob. + +## anvil-splits-minecarts +If enabled, dropping an anvil from significant height onto minecart with content (chest minecart, furnace minecart, etc.) in its item form, it will not destroy the item, but split the minecart and the content and drop them both. + +## anvil-splits-boats +If enabled, dropping an anvil from significant height onto chest boat in its item form, it will not destroy the item, but split the boat and the chest and drop them both. + +## dye-boss-bars +If enabled, allows players to dye boss health bars by right-clicking the boss with a dye item. + +## shields + +### damage-reduction +Value between 0 and 1. This is the percentage of damage reduction that defending with a shield will provide. By default, shield reduces 100% of the damage (1.0). + +### cooldown +Amount of ticks (1/20th of a second) of cooldown for a shield after hitting it with an axe crit. By default, this is 100 ticks (5 seconds). + +## items + +### beehive-lore + +If true, will add lore with amount of bees and honey to the picked up hives. + +## lightning-transforms-entities + +If enabled, entities with type on the left will be transformed into entity of type on the right. This overrides vanilla transformations. Vanilla mob ids are used to identify mobs. There are also special cases: + +- `killer_bunny` - a killer bunny +- `jeb_sheep` - rainbow sheep +- `johhny` - vindicator aggressive to most mobs +- `toast` - special variant of rabbit + +## blocks + +### shift-right-click-for-invisible-item-frames +Right click when sneaking on an item frame with item inside of it will make the item frame invisible. Requires `purpurextras.invisibleframes` permission. + +### chorus-flowers-always-drop +Makes it so chorus flowers always drop, no matter if they were destroyed directly or not. + +## block-building-above-nether + +### enabled +Enables the feature. + +### height-limit +Maximum height players without `purpurextras.netherbuildheightbypass` permission can build in nether worlds. + +### no-permission-message +Message to display in action bar when trying to build above set limit in nether worlds. + +## gameplay-settings + +### respawn-anchor-needs-charges +If false, will make it so respawn anchors will never run out of charges. + +### open-iron-doors-with-hand +Allows opening iron doors with a hand, just like wooden doors. + +### open-iron-trapdoors-with-hand +Allows opening iron trapdoors with a hand, just like wooden trapdoors. + +### spawner-placement-requires-specific-permission +Players will need `purpurextras.spawnerplace.` permission to place spawners of that mob. + +### cancel-damage-from-pet-owner +If enabled, pet owners will not be able to harm their own pets. + +### fall-damage-when-jump-boost-applied +Toggles if entities with jump boost effect will take fall damage + +### run-faster-on-paths +If `speed-multiplier` value is higher than 0, player will gain speed potion effect of the level of that value. This only accepts integer values. Which blocks count as paths can be configured by listing them in `path-blocks` list. + +## chat + +### escape-commands +Allows players to send a message with a slash at the start by escaping it with backslash (`\/command` that will appear as `/command` in chat). + +### send-sleep-percentage-message +If enabled, sends messages in chat containing amount of players required to sleep based on playersSleepingPercentage gamerule. + +## anvil-crushes-blocks + +If enabled, block list will be used. Key is the block material that will be converted from and value is block material that will be converted to. In default config if anvil falls on a cobblestone block, that cobblestone will be converted to sand. + +## dispenser + +### break-blocks + +If a tool category is enabled, that tool dispensed from dispenser will destroy the block in front of it. It will only destroy blocks that tool can destroy, and it will destroy them like that tool was used on it, so wooden pickaxe will destroy diamond ore, but will not drop any items. + +### shears-shear-pumpkin + +If enabled, when shears are dispensed and there's a pumpkin in front of a dispenser, shears will be used, making carved pumpkin. + +### interact-with-cauldron + +If enabled, will allow dispensers fill and empty cauldrons. + +### puts-discs-in-jukebox + +If enabled, dispensers will be able to insert into or swap music discs in jukeboxes. + +## grindstone + +### gives-enchants-back + +If enabled and player has books in their inventory while disenchanting item in a grindstone, books will be consumed to return the enchantments removed from the item to the player. No exp will drop when doing this. + +## rideables + +### mob-needs-to-be-nametagged-to-ride + +If enabled, only name tagged mobs can be mounted/steered using Purpur's rideable option. + +## furnace + +### burn-time + +If enabled, multiplier field will be used to modify fuel burn time in furnaces. + +## totem + +### work-on-void-death + +If enabled, totem of undying will save players from death in the void and will teleport them to the last place their feet touched the ground. If for any reason that position is not found, they will be teleported to world spawn. + +## Message types + +### CHAT +Regular system chat message + +### ACTION_BAR +Action bar message \ No newline at end of file diff --git a/mkdocs/purpurextras/index.md b/mkdocs/purpurextras/index.md new file mode 100644 index 0000000..c40e129 --- /dev/null +++ b/mkdocs/purpurextras/index.md @@ -0,0 +1,39 @@ +[![Purpur Image](https://user-images.githubusercontent.com/74448585/150906023-101cd383-da82-4a3c-9603-a3b5741c3994.png)]({{ project.website }}) + +
+ +[![MIT License](https://img.shields.io/github/license/PurpurMC/PurpurExtras?&logo=github)](License)  +[![Join us on Discord](https://img.shields.io/discord/685683385313919172.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)]({{ social[0].link }})  + +[![Purpur's Stargazers](https://img.shields.io/github/stars/PurpurMC/PurpurExtras?label=stars&logo=github)]({{ project.source }}/stargazers)  +[![Purpur Forks](https://img.shields.io/github/forks/PurpurMC/PurpurExtras?label=forks&logo=github)]({{ project.source }}/network/members)  +[![Purpur Watchers](https://img.shields.io/github/watchers/PurpurMC/PurpurExtras?label=watchers&logo=github)]({{ project.source }}/watchers)  + +Welcome to the official documentation source for the [PurpurExtras]({{ purpur_extras.source }}/) project. + +PurpurExtras is a plugin that contains features that were suggested to be added to Purpur but were deemed easier to +implement in a form of a plugin. + +
+ +## Contact [![Discord shield.io](https://img.shields.io/discord/685683385313919172.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)]({{ social[0].link }}) + +Join us on [Discord]({{ social[0].link }})! + +## Downloads + +You can download PurpurExtras from [modrinth]({{ purpur_extras.downloads }}). + + +## License [![MIT License](https://img.shields.io/github/license/PurpurMC/PurpurExtras?&logo=github)](./#license) + + +## Development + +#### Building + +Clone the project and use the command `./gradlew shadowJar` to build the plugin. + +#### Testing + +You can quickly run a test server with PurpurExtras by using the command `./gradlew runServer`. diff --git a/mkdocs/purpurextras/installation.md b/mkdocs/purpurextras/installation.md new file mode 100644 index 0000000..ccfe6d7 --- /dev/null +++ b/mkdocs/purpurextras/installation.md @@ -0,0 +1 @@ +PurpurExtras is just a regular plugin. Simply place it into your `plugins` directory and restart the server. diff --git a/mkdocs/purpurpacks/index.md b/mkdocs/purpurpacks/index.md new file mode 100644 index 0000000..f9dc4fb --- /dev/null +++ b/mkdocs/purpurpacks/index.md @@ -0,0 +1,29 @@ +[![Purpur Image](https://user-images.githubusercontent.com/74448585/150906023-101cd383-da82-4a3c-9603-a3b5741c3994.png)]({{ project.website }}) + +
+ +[![MIT License](https://img.shields.io/github/license/PurpurMC/PurpurPacks?&logo=github)](https://github.com/PurpurMC/PurpurPacks?tab=MIT-1-ov-file)  +[![Github Actions Build](https://img.shields.io/github/workflow/status/purpurmc/purpurpacks/Build?event=push&logo=github)]({{ purpur_packs.downloads }}) +[![Join us on Discord](https://img.shields.io/discord/685683385313919172.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)]({{ social[0].link }})  + +[![PurpurPacks' Stargazers](https://img.shields.io/github/stars/PurpurMC/Purpur?label=stars&logo=github)]({{ purpur_packs.source }}/stargazers)  +[![PurpurPacks' Forks](https://img.shields.io/github/forks/PurpurMC/Purpur?label=forks&logo=github)]({{ purpur_packs.source }}/network/members)  +[![PurpurPacks' Watchers](https://img.shields.io/github/watchers/PurpurMC/Purpur?label=watchers&logo=github)]({{ purpur_packs.source }}/watchers)  + +Welcome to the official documentation source for the [PurpurPacks]({{ purpur_packs.source }}/) project. + +PurpurPacks are features that have been suggested to be added to the [Purpur](https://purpurmc.org/) server software - or would fit Purpur's theme, but were decided would fit better as a datapack! +Each datapack functions the same as a singular configuration setting would in Purpur. +These packs can be added and removed at any time without damaging the server. +These datapacks do not depend on Purpur; they work well in vanilla or any other server software. +
+ +## Contact [![Discord shield.io](https://img.shields.io/discord/685683385313919172.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)]({{ social[0].link }}) + +Join us on [Discord]({{ social[0].link }})! + +## Downloads + +You can download PurpurPacks from their individual [Modrinth Pages](https://modrinth.com/user/PurpurMC/datapacks). + +## License [![MIT License](https://img.shields.io/github/license/PurpurMC/PurpurPacks?&logo=github)](https://github.com/PurpurMC/PurpurPacks?tab=MIT-1-ov-file) diff --git a/mkdocs/purpurpacks/installation.md b/mkdocs/purpurpacks/installation.md new file mode 100644 index 0000000..adf739b --- /dev/null +++ b/mkdocs/purpurpacks/installation.md @@ -0,0 +1,37 @@ +[![Purpur Image](https://user-images.githubusercontent.com/74448585/150906023-101cd383-da82-4a3c-9603-a3b5741c3994.png)]({{ project.website }}) + +# Installation instructions for Bukkit/Spigot/Paper and so on: +* Find your default world folder +* Place the datapack into the default world folder, in the 'datapacks' directory +* Restart the server + +> Note: Datapacks cannot currently be separated per-world in Bukkit and forks. + +# Installation instructions for Vanilla minecraft: +* Open your save file +* Add the datapack to the datapack directory +* Restart the server + +# Installation for modded minecraft: +There are mod versions available of these datapacks, which are functionally identical to the datapacks themselves. +The mod versions of the datapack will apply to any new world that is created while the mod is enabled. +This makes it more useful for some cases, but not really for others. Datapacks can still be used in modded environments. + +> Note: The mod version cannot be used on Bukkit, Spigot, Paper, Pufferfish, or Purpur servers + +# Installation instructions for Fabric (Mod) +* Download the mod version of the datapack from modrinth. +* Download Fabric API +* Add both mods to your mods folder +* Restart your client + +# Installation instructions for Quilt (Mod) +* Download the mod version of the datapack from modrinth. +* Download Quilted Fabric API +* Add both mods to your mods folder +* Restart your client + +# Installation instructions for Forge (Mod) +* Download the mod version of the datapack from modrinth +* Add the mod to your mods folder +* Restart your client \ No newline at end of file diff --git a/mkdocs/purpurpacks/packs.md b/mkdocs/purpurpacks/packs.md new file mode 100644 index 0000000..5baa1fb --- /dev/null +++ b/mkdocs/purpurpacks/packs.md @@ -0,0 +1,137 @@ +## Smithing Recipes + +#### [Upgrade Diamond Armor to Netherite Without A Template](https://modrinth.com/datapack/purpurpacks-no-template-netherite-armor-upgrades) +* Allows upgrading diamond armor to netherite armor in a smithing table without the use of a netherite upgrade template +* Re-enables the functionality from pre-1.20 + +#### [Upgrade Diamond Tools to Netherite Without A Template](https://modrinth.com/datapack/purpurpacks-no-template-netherite-tool-upgrades/versions) +* Allows upgrading diamond tools to netherite tools in a smithing table without the use of a netherite upgrade template +* Re-enables the functionality from pre-1.20 + +#### [Upgrade Iron Armor to Diamond Armor](https://modrinth.com/datapack/purpurpacks-iron-to-diamond-armor-upgrades/versions) +* Allows upgrading iron armor to diamond armor by combining a piece of iron armor with a diamond in a smithing table +* Does not require an upgrade template + +#### [Upgrade Iron Tools To Diamond Ones](https://modrinth.com/datapack/purpurpacks-iron-to-diamond-tools-upgrades/versions) +* Allows upgrading iron tools to diamond tools by combining an iron tool with a diamond in a smithing table +* Does not require an upgrade template + +#### [Upgrade Stone Tools To Iron Ones](https://modrinth.com/datapack/purpurpacks-stone-to-iron-tools-upgrades/versions) +* Allows upgrading stone tools to iron tools by combining a stone tool with an iron ingot in a smithing table +* Does not require an upgrade template + +#### [Upgrade Wood Tools To Stone Ones](https://modrinth.com/datapack/purpurpacks-wooden-to-stone-tools-upgrades/versions) +* Allows upgrading wooden tools to stone tools by combining a wooden tool with cobblestone, blackstone, or cobbled + deepslate in a smithing table +* Does not require an upgrade template + +## Crafting Recipes + +#### [Re-Dye All Colors of Terracotta](https://modrinth.com/datapack/purpurpacks-re-dye-terracotta/versions) +* Allows crafting dyed terracotta with any type of terracotta that has not been glazed. + +#### [Re-Dye All Colors of Concrete](https://modrinth.com/datapack/purpurpacks-re-dye-concrete-powder/versions) +* Allows crafting a different color of concrete powder with concrete powder + +#### [Re-Dye All Colors Of Glass](https://modrinth.com/datapack/purpurpacks-re-dye-glass/versions) +* Allows crafting stained-glass and stained-glass panes with all colors of glass and glass panes + +#### [Dye 8 Wool or Carpet at a Time Instead Of One](https://modrinth.com/datapack/purpurpacks-more-dyed-wool-and-carpet/versions) +* Adds a recipe that allows for 8 wool or carpet to be dyed instead of only one. + +#### [Craft Dyed Shulkers From Scratch](https://modrinth.com/datapack/purpurpacks-one-step-dyed-shulker-boxes/versions) +* Adds a recipe to craft dyed shulkers from the base ingredients (chest, 2 shulker shells, and dye) + +#### [Smelt Raw Ore Blocks](https://modrinth.com/datapack/purpurpack-smelt-raw-ore-blocks) +* Adds a furnace and blast furnace recipe for raw ore blocks + +#### [Blasting Furnace Smelts Glass](https://modrinth.com/datapack/purpurpack-blasting-smelts-glass) +* Adds a blast furnace recipe for glass + +## Loot Tables + +#### [Add Netherite Smithing Template to Piglin barter table](https://modrinth.com/datapack/purpurpacks-one-step-dyed-shulker-boxes/versions) +* Adds the netherite smithing template to the piglin barter trade loot table + +#### [Pick Up Budding Amethyst blocks with Silk Touch](https://modrinth.com/datapack/purpurpacks-silk-touch-budding-amethyst/versions) +* Enables picking up budding amethyst blocks with silk-touch tools + +#### [Pick Up Reinforced Deepslate blocks with Silk Touch](https://modrinth.com/datapack/purpurpacks-silk-touch-reinforced-deepslate/versions) +* Enables picking up reinforced deepslate blocks with silk-touch tools + +## Effective tools + +#### [Light Source Blocks Break Faster With A Pickaxe](https://modrinth.com/datapack/purpurpacks-pickaxe-effective-light-source-blocks/versions) +* Adds glowstone, sea lanterns and other light source blocks to the pickaxe minable tag +* Allows pickaxes to break light source blocks far faster + +#### [Glass Breaks Faster With A Pickaxe](https://modrinth.com/datapack/purpurpacks-pickaxe-effective-glass/versions) +* Adds glass to the pickaxe minable tag +* Allows pickaxes to break glass blocks and panes far faster + +#### [Reinforced Deepslate Breaks Faster With A Pickaxe](https://modrinth.com/datapack/purpurpacks-pickaxe-effective-reinforced-deepslate/versions) +* Adds reinforced deepslate to the pickaxe minable tag +* Allows pickaxes to break reinforced deepslate blocks far faster + +#### [Froglights Break Faster Using A Hoe](https://modrinth.com/datapack/purpurpacks-hoe-effective-froglights/versions) +* Adds froglights to the hoe mineable tag +* Allows hoes to break froglights far faster + +#### [Cactus Breaks Faster With A Hoe](https://modrinth.com/datapack/purpurpacks-hoe-effective-cactus/versions) +* Adds cactus to the hoe mineable tag +* Allows hoes to break cactus far faster + +#### [Skulls And Heads Break Faster With An Axe](https://modrinth.com/datapack/purpurpacks-axe-effective-skulls/versions) +* Adds skulls and heads to the axe mineable tag +* Allows axes to break skulls and heads far faster + +## Mob behavior + +#### [Axolotls Do Not Attack Passive Mobs](https://modrinth.com/datapack/purpurpack-axolotls-ignore-passives/versions) +* Disables axolotls attacking passive mobs +* Does not disable axolotls from attacking hostile mobs or fighting back + +#### [Axolotl Breed With Tropical Fish Item](https://modrinth.com/datapack/purpurpack-breed-axolotl-with-tropical-fish-item) +* Allows axolotls to breed when fed tropical fish items and not only the tropical fish bucket + +## World Behavior + +#### [The Four New Paintings Are Placeable](https://modrinth.com/datapack/purpurpacks-placeable-new-paintings/versions) +* Allows players to place the 4 new paintings in survival + +#### [Chiseled Bookshelves Add To Enchantment Power](https://modrinth.com/datapack/purpurpacks-chiseled-bookshelves-add-enchantment-power/versions) +* Allows chiseled bookshelves to contribute to the enchant power total like a normal bookshelf + +#### [Transparent Blocks Do Not Reduce Enchant Power In Enchant Area](https://modrinth.com/datapack/purpurpacks-transparent-blocks-in-enchant-area/versions) +* Allows most transparent/non-full blocks to be used in the enchant area without taking enchant power away from the + enchant table + +## Beacon Base Materials + +#### [Copper Blocks Can Be Used As A Beacon Base](https://modrinth.com/datapack/purpurpacks-copper-block-beacon-base/versions) +* Allows all types of full copper blocks to be used in a beacon base +* Allows using a copper ingot as a beacon payment item + +#### [Redstone Blocks Can Be Used As A Beacon Base](https://modrinth.com/datapack/purpurpacks-redstone-beacon-base/versions) +* Allows redstone blocks to be used in a beacon base +* Allows using redstone dust as a beacon payment item + +#### [Lapis Blocks Can Be Used As A Beacon Base](https://modrinth.com/datapack/purpurpacks-lapis-beacon-base/versions) +* Allows lapis blocks to be used in a beacon base +* Allows using lapis lazuli as a beacon payment item + +#### [Amethyst Blocks Can Be Used As A Beacon Base](https://modrinth.com/datapack/purpurpacks-amethyst-beacon-base/versions) +* Allows amethyst blocks and budding amethyst to be used in a beacon base +* Allows using amethyst shards as a beacon payment item + +#### [Raw Gold Blocks Can Be Used As A Beacon Base](https://modrinth.com/datapack/purpurpacks-raw-gold-beacon-base/versions) +* Allows raw gold blocks to be used in a beacon base +* Allows using raw gold as a beacon payment item + +#### [Raw Iron Blocks Can Be Used As A Beacon Base](https://modrinth.com/datapack/purpurpacks-raw-iron-block-beacon-base/versions) +* Allows raw iron blocks to be used in a beacon base +* Allows using raw iron as a beacon payment item + +#### [Raw Copper Blocks Can Be Used As A Beacon Base](https://modrinth.com/datapack/purpurpacks-raw-copper-beacon-base/versions) +* Allows raw copper blocks to be used in a beacon base +* Allows using raw copper as a beacon payment item \ No newline at end of file diff --git a/mkdocs/stylesheets/extra.css b/mkdocs/stylesheets/extra.css index bedc3ed..1355145 100644 --- a/mkdocs/stylesheets/extra.css +++ b/mkdocs/stylesheets/extra.css @@ -23,7 +23,7 @@ div#center { letter-spacing: -0.01em; } -.md-header { +.md-header, .md-tabs { background-color: var(--header-color); } diff --git a/requirements.txt b/requirements.txt index 0be04af..fd1f843 100644 --- a/requirements.txt +++ b/requirements.txt @@ -15,6 +15,7 @@ Markdown==3.3.3 MarkupSafe==2.1.1 mergedeep==1.3.4 mkdocs==1.4.1 +mkdocs-ezlinks-plugin==0.1.14 mkdocs-markdownextradata-plugin==0.2.5 mkdocs-material==8.5.7 mkdocs-material-extensions==1.1 @@ -22,6 +23,7 @@ mkdocs-redirects==1.0.3 nltk==3.5 packaging==21.3 Pygments==2.13.0 +pygtrie==2.5.0 pymdown-extensions==9.7 pyparsing==3.0.9 python-dateutil==2.8.2