Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mitjafelicijan/turtletweaks

World of Warcraft 1.12 Tweaks and Enhancements Addon
https://github.com/mitjafelicijan/turtletweaks

turtle-wow wow wow-addon wow-classic wow-vanilla

Last synced: 2 months ago
JSON representation

World of Warcraft 1.12 Tweaks and Enhancements Addon

Awesome Lists containing this project

README

        

# TurtleTweaks

**World of Warcraft Tweaks and Enhancements addon.**

**Consideration:** Please note that this addon is not designed to compete with
any other addon. It is simply a compilation of tweaks and enhancements that I
have found to be useful. If you require additional functionality, I suggest
checking out [ShaguTweaks](https://shagu.org/ShaguTweaks/), an outstanding addon
that has been a source of inspiration for me. My approach is to prioritize
simplicity and lightness. I avoid including features that I don't personally
use. As a result, I don't use many other addons either. My addon provides
only a few quality of life improvements.

Please note that none of the options are enabled by default, and you will need
to manually opt-in to each one. I designed it this way to align with the
vanilla experience and avoid forcing pre-selected preferences on users.

## Compatibility

This addon works with the following clients:
- World of Warcraft (client version 1.12 / TurtleWoW)

This addon may work with the following clients:
- World of Warcraft (client version 1.13.2 / Classic)
- World of Warcraft (client version 2.4.3 / The Burning Crusade)
- World of Warcraft (client version 3.3.5a / Wrath of the Lich King)

I haven't tested it with any other clients, but it may work with others.

## Installation

1. Download the latest release from the Releases.
2. Extract the contents of the archive into your `World of Warcraft\Interface\AddOns` folder.
3. Rename the extracted folder to `TurtleTweaks` (remove the version number).
4. Restart the game client.

## Screenshots

![Settings panel](https://github.com/mitjafelicijan/TurtleTweaks/assets/296714/910bfad2-9c78-4b35-bc48-e58f7cafa840)

## Features

- Rested XP display in the Player unit frame.
- Displays number of free bag slots in the backpack button.
- Opens loot window at current mouse position.
- Adds a bunch of slash commands for various things:
- `/addons` - List all currently loaded addons
- `/reloadui`, `/reload`, `/rl` - Reload the UI
- `/align` - Toggle the alignment grid
- Maximum Camera Distance slider to the options.
- Default nameplate scaling slider to the options that can fix large nameplates.
- Enables World Map to be opened in a window and scaled.
- Adds cooldown timers to the actionbar buttons.

## Development Information

- [World of Warcraft API Documentation](https://wow.gamepedia.com/World_of_Warcraft_API)
- [World of Warcraft Widget API Documentation](https://wowpedia.fandom.com/wiki/Widget_API)
- [WoW Vanilla Addons Website](https://legacy-wow.com/vanilla-addons/)
- [Comprehensive Beginner's Guide for WoW Addon Coding in Lua](https://www.wowhead.com/guide/comprehensive-beginners-guide-for-wow-addon-coding-in-lua-5338)
- [WoW 1.12 Interface Explorer](https://wow-tools.vercel.app)

## Special Thanks

- [Shagu](https://shagu.org/) for creating [ShaguTweaks](https://shagu.org/ShaguTweaks/), which has been a source of inspiration for me.
- [Turtle WoW](https://turtle-wow.org/) for creating a great vanilla WoW server.
- [Blizzard Entertainment](https://www.blizzard.com/) for creating World of Warcraft.
- [The WoW AddOn Community](https://www.curseforge.com/wow/addons) for creating and maintaining addons.

## Additional Inspiration

- https://github.com/anzz1/FreeBagSlots
- https://github.com/hazlema/Rested
- https://github.com/Steelbash/RestBar

## Contributing

If you would like to contribute to this project, please feel free to submit a
[pull request](https://github.com/mitjafelicijan/TurtleTweaks/pulls).
I will review it as soon as I can.

## License

This project is licensed under the BSD 2-Clause License - see the [LICENSE](LICENSE) file for details.