-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
67 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,82 @@ | ||
| # Stardust | ||
| # ✨ Stardust | ||
|
|
||
| Stardust is an addon for [Meteor Client](https://meteorclient.com) designed for use on the | ||
| anarchy Minecraft server [2b2t](https://2b2t.org).<br> | ||
| It provides a handful of modules for enhancing your experience on old server.<br><br> | ||
| It contains original modules to enhance your experience on Old Server, with a focus on configurability and polish. | ||
|
|
||
| ### Feature Set | ||
| #### Commands | ||
|
|
||
| - **LastSeen2b2t, FirstSeen2b2t, Playtime2b2t** - *Self explanatory commands. Use your meteor prefix.* Credit to [rfresh](https://github.com/rfresh2) for the current best [2b2t stats api](https://api.2b2t.vc). | ||
| - **Panorama** - *Takes a panorama screenshot and automatically assembles it into a resource pack for the main menu screen.* Usage: `.panorama [name]` | ||
| | Command | Description | | ||
| |----------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Stats2b2t, LastSeen2b2t, FirstSeen2b2t, Playtime2b2t** | *Self explanatory commands. Use your Meteor command prefix.* Credit to [rfresh](https://github.com/rfresh2) for the current best [2b2t stats api](https://api.2b2t.vc). | | ||
| | **Panorama** | *Takes a panorama screenshot and automatically assembles it into a resource pack for the main menu screen.* Usage: `.panorama [name]` | | ||
|
|
||
| <br> | ||
|
|
||
| #### Modules | ||
| - **SignatureSign** - *An AutoSign module that's actually good.* Fully customizable template mode, & story mode for long input files over multiple signs. | ||
| - **SignHistorian** - *Record and restore broken or modified signs that you previously visited.* Since 1.19, creepers have been a real problem for sign boards everywhere. Now even if they blow that shit up, all is not lost. | ||
| - **AxolotlTools** - *Variant ESP, auto-collector & auto-breeder for axolotls.* Can also catch buckets of tropical fish, with or without a farm setup. I used this to get blue axolotls on 2b2t because interacting with them normally pisses me off. | ||
| - **AutoDoors** - *Automatically interacts with doors.* Includes an insufferable door spammer mode as well (complete with client-side mute option). | ||
| - **AntiToS** - *Censors player-generated text on render, like signs, books, and chat, according to a customizable content blacklist.* | ||
| - **AutoDrawDistance** - *Automatically adjusts your render distance to maintain an FPS target.* Some biomes/areas can drop my fps by half, so I found this somewhat useful at times. | ||
| - **AutoDyeShulkers** - *Automatically dye shulker boxes a desired color in crafting grids.* | ||
| - **LoreLocator** - *Slot highlighter for rare, unique, and anomalous items.* Capable of highlighting renamed items, items with illegal enchants, negative durability values, and more. | ||
| - **BannerData** - *Right-click banners to display their pattern and color data.* Looks cool, gives you the base color without any fuss. Can also copy the raw nbt to your clipboard. | ||
| - **BookTools** - *Enhancements for working with books.* Adds buttons for inserting color & formatting codes into writable books, and adds a deobfuscation button to written books containing obfuscated/magic text. | ||
| - **StashBrander** - *Automatically rename desired items in bulk when using anvils.* | ||
| - **TreasureESP** - *An ESP module for buried treasure chests.* Finding buried treasure is the only way of obtaining Hearts of the Sea, and Conduits by extension. | ||
| - **MusicTweaks** - *Lets you tweak various things relating to the background music.* Change the pitch, volume, or cooldown between songs, or even choose and view which soundtracks play during your session. | ||
| - **RocketMan** - *Makes flying with fireworks much easier (bring lots of rockets!)* This doesn't feature any fancy grim control bypasses or anything like that. This is just a good clean quasi-control firework efly that won't be patched as long as you have access to rockets (which are currently afkable.) | ||
| - **Honker** - *Automatically uses goat horns when a player enters your render distance.* You can select your preferred horn type, or choose random for a surprise pick from your inventory each time. | ||
| - **WaxAura** - *Automatically waxes signs within your reach.* On 2b2t, sign editing has been disabled "for now™". This module makes it easy to wax as many signs as possible before it gets enabled. | ||
| - **ChatSigns** - *Read nearby signs in your chat.* Can also highlight potentially old pre-1.8 signs*. | ||
|
|
||
| **\*1.19+ OldSigns**<br> | ||
| *Now that 2b2t has updated to 1.19, old sign (pre 1.8) metadata is now identical to metadata for new oak signs placed in old chunks after the update. Metadata for signs placed in versions 1.8-1.12 is still recognizable as such.*<br> | ||
|
|
||
| This means that false positives are now **unavoidable**, but the new module takes into account the likelihood of a sign being old based on whether it is in old chunks, is an oak sign, and doesn't contain dates >= 2015.<br> | ||
|
|
||
| It isn't useless, but you will have to use your best judgement to determine what is legitimately likely to be old. | ||
|
|
||
| **I have not made a separate ESP module for OldSigns.** *You'll need to configure the OldSign ESP functionality built-in to ChatSigns instead.* | ||
|
|
||
| --- | ||
| | Module | Description | | ||
| |----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **ChatSigns** | *Read nearby signs in your chat.* Can also highlight and ESP potentially old signs placed before version 1.8 (January 2015 on 2b2t.)* | | ||
| | **SignatureSign** | *An AutoSign module that's actually good.* Fully customizable template mode, & story mode for long input files over multiple signs. | | ||
| | **SignHistorian** | *Record and restore broken or modified signs that you previously visited.* Since 1.19, creepers have been a real problem for sign boards everywhere. Now even if they blow that shit up, all is not lost. | | ||
| | **RocketMan** | *Makes flying with fireworks much easier (and faster!) \[bring lots of rockets!\]* RocketMan is a versatile and highly-configurable firework efly module with many useful capabilities. | | ||
| | **StashBrander** | *Automatically rename desired items in bulk when using anvils.* | | ||
| | **AutoDoors** | *Automatically interacts with doors.* Includes an insufferable door spammer mode as well (complete with client-side mute option). | | ||
| | **AutoSmith** | *Automatically upgrades gear or trims armor sets when interacting with smithing tables.* | | ||
| | **AntiToS** | *Censors player-generated text on render, like signs, books, chat, and more, according to a customizable content blacklist.* | | ||
| | **LoreLocator** | *Slot highlighter for rare, unique, and anomalous items.* Capable of highlighting renamed items, items with illegal enchants, zero durability items, and more. | | ||
| | **AxolotlTools** | *Variant ESP, auto-collector & auto-breeder for axolotls.* Can also catch buckets of tropical fish, with or without a farm setup. I used this to get blue axolotls on 2b2t because interacting with them normally pisses me off. | | ||
| | **AutoDrawDistance** | *Automatically adjusts your render distance to maintain an FPS target.* Some biomes/areas can drop my fps by half, so I occasionally find this useful. | | ||
| | **AutoDyeShulkers** | *Automatically dye shulker boxes a desired color in crafting grids.* | | ||
| | **BannerData** | *Right-click banners to display their pattern and color data.* Looks cool, gives you the base color without any fuss. Can also copy the raw nbt to your clipboard. | | ||
| | **BookTools** | *Enhancements for working with books.* Adds buttons for inserting color & formatting codes into writable books, and adds a deobfuscation button to written books containing obfuscated/magic text. | | ||
| | **PagePirate** | *Pirates books held by other players* (displays their contents in your chat, and optionally makes a local copy using a book & quill). Also allows you to highlight and view the contents of books in item frames, and dropped on the ground as items. | | ||
| | **TreasureESP** | *An ESP module for buried treasure chests.* Finding buried treasure is the only way of obtaining Hearts of the Sea, and Conduits by extension. | | ||
| | **MusicTweaks** | *Lets you tweak various things relating to the background music.* Change the pitch, volume, or cooldown between songs, or even choose and view which soundtracks play during your session. | | ||
| | **Honker** | *Automatically uses goat horns when a player enters your render distance.* You can select your preferred horn type, or choose random for a surprise pick from your inventory each time. | | ||
| | **WaxAura** | *Automatically waxes signs within your reach.* On 2b2t, sign editing has been disabled "for now™". This module makes it easy to wax as many signs as possible before it gets enabled. | | ||
|
|
||
| >*OldSigns: <br> | ||
| Ever since 2b2t updated to 1.19, the NBT tag artifact that separates pre-1.8 from post-1.8 signs is missing on newly-placed signs.<br> | ||
| This means that false positives are now *unavoidable*, but should be limited to *oak signs placed after 1.19 in old (pre-1.8) chunks, which don't contain dates after 2015*.<br> | ||
| Use your best judgement to further identify false positives or fakes.<br> | ||
| OldSigns functionality can be accessed in the ChatSigns module settings. | ||
|
|
||
| <br> | ||
|
|
||
| #### Miscellaneous | ||
|
|
||
| | Feature | Description | | ||
| |---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Illegal Disconnect** | *Adds a config setting to put a dedicated Illegal Disconnect button on the pause menu.* Find this in your Meteor config settings, in the Stardust category. | | ||
| | **Click-to-Come** | *When using Meteor's Freecam module, click on a block or entity to Baritone path there.* Enable this in the Freecam module's settings. | | ||
| | **Elytra Mending** | *Tweaks Meteor's built-in AutoMend module to allow automatically equipping damaged elytras for mending.* This can be used in conjunction with offhand mending, or exclusively by enabling the "ignore offhand" setting. | | ||
| | **Title Screen Tweaks** | *2b2t-themed changes to the title screen.* Adds config settings to make the splash texts green, to cycle them randomly, and to add a 2b2t direct-connect button to the title screen. | | ||
| | **Themed Category Icons** | *Enable module category icons in your Meteor GUI settings to see a random Stardust/2b2t-themed icon for the Stardust modules category.* Randomly picks a new icon each time you launch your game! | | ||
|
|
||
| <br> | ||
|
|
||
| ### Installation | ||
|
|
||
| 1. Ensure that [Fabric](https://fabricmc.net) for Minecraft versions 1.20.1 or 1.20.4 are installed. | ||
| 2. Download the [latest release](https://github.com/0xTas/stardust/releases/latest) which corresponds to your selected version,<br>or build the desired branch of the addon from source with `./gradlew build`. | ||
| 3. Drop the .jar file in your `.minecraft/mods` folder, along with Meteor Client (v0.5.4 for 1.20.1, v0.5.6 for 1.20.4) | ||
| 1. Ensure that [Fabric](https://fabricmc.net) for Minecraft version 1.20.1, 1.20.4, 1.21, or 1.21.1 is installed. | ||
| 2. Download the [latest release](https://github.com/0xTas/stardust/releases/latest), or build the addon from source with `./gradlew build`. **Make sure to use the version that corresponds to your Minecraft version!** | ||
| 3. Drop the .jar file in your `.minecraft/mods` folder, along with Meteor Client (v0.5.4 for MC 1.20.1, v0.5.6 for MC 1.20.4, and v0.5.8-2199 or later for MC 1.21 & 1.21.1.) | ||
| 4. Run your Fabric installation. | ||
| <br> | ||
|
|
||
| ### Building & Contributing | ||
|
|
||
| 1. Building the addon requires that a Java SDK is installed, and in your PATH environment. (Java 17 required for 1.20.1 & 1.20.4, Java 21 required for 1.21+) | ||
| 2. After cloning and inspecting the source code, the addon can be built with the `./gradlew build` command. | ||
| 3. To contribute, IntelliJ Idea is recommended. First, run the `./gradlew genSources` task to generate a mapped version of Minecraft's code locally. | ||
| 4. Then you can apply those mappings by ctrl+clicking on any Minecraft class and selecting `Choose Sources` from the red banner across the top. | ||
| 5. Select the appropriate sources Jar from the list (usually named something like `net.minecraft:minecraft-merged-...-sources.jar`) and hit `Ok`. | ||
| 6. Now you can contribute or modify code with those mappings as a reference (ctrl+click to view the source for any class.) | ||
|
|
||
| --- | ||
| ### Contributing | ||
| Issues and pull requests are welcome if you would like to submit them.<br> | ||
| You can also get in touch with me if needed in the [Meteor Client Discord](https://discord.com/invite/bBGQZvd). | ||
| >Issues and pull requests are welcome if you would like to submit them. | ||
| <br> | ||
| --- | ||
| ### Credits | ||
| - [**Meteor Development**](https://github.com/MeteorDevelopment) *for [Meteor Client](https://meteorclient.com).* | ||
| - [**rfresh**](https://github.com/rfresh2) *for the [2b2t statistics api](https://api.2b2t.vc).* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters