Skip to content

Commit

Permalink
Add readme-to-bbcode script
Browse files Browse the repository at this point in the history
  • Loading branch information
AmericanBagel committed Mar 19, 2023
1 parent f4e555d commit 372550e
Show file tree
Hide file tree
Showing 4 changed files with 307 additions and 6 deletions.
130 changes: 130 additions & 0 deletions README.bbcode.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
[h1][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/title.png][/h1]
[div]See the PlanetMinecraft page here: [url=https://www.planetminecraft.com/data-packs/5537948]https://www.planetminecraft.com/data-packs/5537948[/url][/div]
[h1][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/why.png][/h1]
[div]Browsing through [url=https://www.planetminecraft.com/data-packs/]PlanetMinecraft's data pack page[/url], you will quickly notice the amount of "Minecraft, but" data packs that flood it. You might think all these data packs sound fun. After playing with one, you might want to use several. What if you used 5, 10, 15, even 20 different "Minecraft, but" data packs? You'll quickly find yourself annoyed with having to manually type out [code]/datapack disable "file/..."[/code]. You will also find it annoying that very few of them are customizable! For the data packs that are customizable, you will often forget how you were supposed to customize them in the first place! Managing several of these data packs quickly turns into a nightmare.[/div]
[div]The [b]Minecraft, but MEGAPACK[/b] aims to solve this problem by providing one centralized menu to manage all your gameplay modifiers. Gone are the days of typing [code]/datapack[/code]! Gone are the days of having to revisit that PlanetMinecraft page again and again to remind yourself how to configure it! Gone are the days of having to find that inconveniently placed [code].txt[/code] file hidden away in the archived data pack file! Gone are the days of a chat flooded by 50 different "Minecraft, but" data packs every time you reload.[/div]
[h1][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/features.png][/h1]
[h2][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/modifiers.png][/h2]
[div]The Megapack contains 67 gameplay modifiers (and more on the way), which are essentially "Minecraft, but" scenarios ranging from "Minecraft, but TNT rains from the sky" to "Minecraft, but items randomly fall out of your inventory". The list of modifiers is massive, so bear with me![/div]
<details>
<summary>Full list of modifiers</summary>
<details>
<summary>Challenges (challenges)</summary>
- You can't touch grass (or nature) (botanophobia)<br>
- You can only eat meat (carnivore)<br>
- You always crawl (crawling)<br>
- You can't eat meat (herbivore)<br>
- You have no inventory (limited_inventory)<br>
- You can only look in one direction (look_straight)<br>
- You can't leave water (mermaid)<br>
- There's no gravity (no_gravity)<br>
- You can't touch water (toxic_water)<br>
- Light kills you (troglodyte)<br>
- Taking damage blinds you (blinding_damage)<br>
- All fall damage kills you (deadly_falls)<br>
- You can't stop moving (keep_moving)<br>
</details>
<details>
<summary>Explosions (explosions)</summary>
- All mobs explode like creepers (creeper_mobs)<br>
- Creepers are nuclear (creeper_nukes)<br>
- Arrows explode (explosive_arrows)<br>
- Eggs explode (explosive_eggs)<br>
- Everywhere you look explodes (explosive_sight)<br>
- Snowballs explode (explosive_arrows)<br>
- Bats carry TNT (tnt_bats)<br>
- TNT rains from the sky (tnt_rain)<br>
</details>
<details>
<summary>Chaos (chaos)</summary>
- Anvils rain from the sky (anvil_rain)<br>
- The world disintegrates (degradation)<br>
- Everything around you turns to fire (fire_walker)<br>
- Structures randomly spawn (random_structures)<br>
- An orb of death relentlessly follows you (death_orb)<br>
- Fire rains from the sky (fire_rain)<br>
- Lightning is everywhere (lightning_storm)<br>
</details>
<details>
<summary>Mechanic (mechanic)</summary>
- You can't jump (no_jump)<br>
- You can't sneak (no_sneak)<br>
- You can't sprint (schlatt_mode)<br>
- You can't kill anything (pacifist)<br>
</details>
<details>
<summary>Teleporting (teleporting)</summary>
- Players swap places periodically (Death Swap) (death_swap)<br>
- You randomly teleport (random_teleport)<br>
- Mobs randomly TP to you (mobs_tp_to_you)<br>
- You teleport when you get hurt (ender_blood)<br>
- You randomly teleport to other dimensions (teleport_chorus)<br>
</details>
<details>
<summary>Effects (effects)</summary>
- You get random potion effects (random_effects)<br>
- Taking damage gives you a random effect (suspicious_injury)<br>
- Food gives you random potion effects (potion_food)<br>
- Glowing (glowing)<br>
- Taking damage nauseates you (damage_nausea)<br>
- You are blind. (blindness)<br>
- You get faster the more you walk (walk_leveling)<br>
</details>
<details>
<summary>Mobs (mobs)</summary>
- Phantoms explode (explosive_phantoms)<br>
- Bats are OP (op_bats)<br>
- Ghasts spawn in the overworld (overworld_ghasts)<br>
- Mobs get pigified (pigification)<br>
- Pigs turn into piglins (piglinator)<br>
- Towers of pigs spawn (stacked_pigs)<br>
- Spiders get new abilities (realistic_spiders)<br>
- Skeletons fly (flying_skeletons)<br>
- Mobs get yeeted (yeet)<br>
</details>
<details>
<summary>Miscellaneous (misc)</summary>
- You social distance (2020_mode)<br>
- Colors kill you (deadly_colors)<br>
- Arrows are fast (fast_arrows)<br>
- Mobs explode into confetti when they die (confetti_funeral)<br>
- Bedrock spawns beneath your feet (bedrock_touch)<br>
- OP blocks spawn below your feet (midas_touch)<br>
- Time only moves when you move (superhot)<br>
- Time randomly freezes (frozen_time)<br>
</details>
</details>


[h3][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/configuration.png][/h3]
[div]I aim to make every modifier as customizable as possible. For example, in the &quot;TNT rains from the sky&quot; modifier, you can customize the rate at which the TNT spawns, toggle whether the TNT griefs (automatically set to the mobGriefing gamerule value), and if the TNT spawns from the sky and/or a few blocks above players.[/div]
[div]If you want to reset the configuration for a modifier back to the defaults, each configuration option has a reset button that looks like [⟲].[/div]
[h3][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/difficulty.png][/h3]
[div]Can&#39;t decide what to configure? Many modifiers respect global [b]Difficulty[/b] and automatically change their configuration values to scale with the [b]Global Difficulty[/b], which automatically is set to the world difficulty with [b]Difficulty Sync[/b]. However, you can input a custom global [b]Difficulty[/b] which doesn&#39;t match the world difficulty. You can even configure the difficulty on a per-modifier basis, using each modifier&#39;s [b]Local Difficulty[/b] -- which is set to the Global Difficulty by default.[/div]
[h3][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/blacklisting.png][/h3]
[div]Want to disable a modifier or all modifiers for a certain player? In the config menu of each modifier, you will find an option to blacklist a certain player from that modifier. Alternatively, you can blacklist a player from all modifiers in the main config menu. [b]Players in the spectator gamemode are always blacklisted from almost all modifiers.[/b][/div]
[h3][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/modes.png][/h3]
[div]By default, [b]manual mode[/b] is enabled. [b]Manual mode[/b] allows you to manually enable or disable modifiers -- the way the pack was meant to be. However, there is support for another mode, [b]Random Mode[/b]. Random mode randomly selects modifiers. However, it is highly recommended that you just stick with manual mode. Random mode is incredibly chaotic, unbalanced, and even not fun. However, I created it, so it would be a waste of effort to remove it 🤷. So if you have a world you need quickly destroyed, Random Mode is the way to do it.[/div]
[h2][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/menu.png][/h2]
[h3][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/opening-the-menu.png][/h3]
[div][url=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/menu.mp4]A video guide on opening the menu[/url][/div]
[div]To open the menu, run the command [code]/function minecraft_but.core:give_item[/code]. Bam! Now you have the [b]Chaos Menu[/b]. With this, just right click to bring up the menu. From here you will find different buttons. All that is important is the &quot;Modifier&quot; button, the &quot;Difficulty&quot; slider, and the &quot;Uninstall&quot; button. You can guess what each button does.[/div]
[div]Click on the &quot;Modifier&quot; button to see a list of categories. Feel free to look around these categories. If you need to go back in a menu, just click the back arrow. Now that you&#39;ve looked around these categories, try enabling a modifier by just clicking on its name or the [X] button.[/div]
[h1][img=https://github.com/AmericanBagel/minecraft-but/edit/master/README.mdassets/credits.png][/h1]
[div]So many people have helped with this project, it&#39;s hard to keep count. Still, here&#39;s my best attempt at some sort of &quot;Thank you&quot; list:[/div]
[ul]
[li][url=https://discord.gg/QAFXFtZ]The Minecraft Commands Discord server[/url]. These people are awesome.[/li]
[li][url=https://cloudwolfyt.github.io/index.html]CloudWolfYT[/url] for his scoreboard tree generator, [code]is_sky[/code] predicate, and probably more I can&#39;t think of.[/li]
[li][url=https://mc-datapacks.github.io/en/index.html]MC Datapack Conventions[/url] for conventions to make datapack behave well together[/li]
[li][url=https://github.com/Aeldrion]Aeldrion[/url]&#39;s [url=https://github.com/Aeldrion/AESTD-tag-library]AESTD tag library[/url] for saving me a whole lot of typing and saving my hands and the [url=https://github.com/Aeldrion/Minecraft-Random]Minecraft Random[/url] library which makes most of these modifiers possible![/li]
[li][url=https://github.com/rx-modules/gists/blob/main/dist/dist.mcfunction]rx97&#39;s distance calculation function[/url][/li]
[li][url=https://www.skylinerw.com/vdvman1/raycast/]SkylinerW&#39;s raycast function generator[/url] based on [url=https://discordapp.com/channels/154777837382008833/157097006500806656/537829416894595083]vdvman1&#39;s raycast functions[/url] in the [url=https://discord.gg/QAFXFtZ]Minecraft Commands Discord server[/url][/li]
[li][url=planetminecraft.com/member/cylinderbox/]Cylinderbox[/url]&#39;s [url=https://planetminecraft.com/data-pack/minecraft-but-colors-are-deadly/]Minecraft, but colors are deadly[/url] datapack which served as inspiration for the &quot;Colors are deadly&quot; modifier[/li]
[li]any future contributors to this datapack[/li]
[li]and the obligatory [b]YOU[/b] for reading this and hopefully playing my data pack! You&#39;re the reason I make them![/li]
[/ul]
[h1]🏷️ Todo / Future[/h1]
[div]For plans for the future of this datapack, please view the [url=https://github.com/users/AmericanBagel/projects/2/views/1]GitHub project for this datapack[/url] or refer to the issues.[/div]
[h1]👥 Contributing[/h1]
[div]Feel free to contribute. Any help is appreciated. If it&#39;s something as simple as removing an unnecessary [code]at @s[/code] or even just cleaning up comments, it helps a lot![/div]
[div]If you&#39;re no good with git and GitHub and commands, I totally understand! You can, however, suggest a modifier in the Issues page! Just give it the &#39;modifier&#39; and &#39;enhancement&#39; tags![/div]
Loading

0 comments on commit 372550e

Please sign in to comment.