Skip to content

AtlasUI is a user interface framework that offers pre-made UI elements, unit testing, and utility functions for building efficient and effective glua addons. It also includes an object-relational mapping (ORM) tool for easy data management.

Notifications You must be signed in to change notification settings

8char/AtlasFramework

Repository files navigation

Atlas Framework

Atlas Framework is a framework developed specifically for Garry's Mod, with the goal of making mundane tasks easier and more interconnected. This means that you can use the framework to quickly and easily perform common tasks in your Garry's Mod projects, without having to write everything from scratch.

But that's not all - the framework is open-source, so if you want to improve it or add new features, you can simply fork the repository and make a pull request. This way, the entire community can benefit from your contributions, and the framework will continue to grow and evolve.

So whether you're looking to make your own Garry's Mod projects more efficient, or you want to contribute to the framework itself, Atlas Framework is the perfect tool for you.

Features

  • 📙 SQL query builder
  • 💿 SQL migrations
  • 🖥️ MySQL/SQLite support
  • ⚙️ Easily integrable in-game config system
  • 💎 Tons of pre-built UI panels
  • 🙋 Lots of helper functions
  • 👑 Permissions interface

How to use Atlas Framework in your projects

To start using Atlas Framework, you'll need to compile it first. This process will ensure that all of the framework's code is properly formatted and ready to be used in your projects.

Once the framework has been compiled, you can explore the documentation and learn how to use the various features and functions it offers. With this knowledge, you'll be able to create whatever you want using the Atlas Framework, whether it's a custom UI panel, a complex SQL query, or a helpful helper function.

So go ahead and compile the framework, and start exploring the docs to see what you can create!

Customize

Soon TM

Getting Started

  1. Install LAUX
    • LAUX is a superset of Lua, it will transpile your files down to lua. Basically all LAUX does is adds syntactic sugar.
  2. Navigate to your addons folder, and open a terminal/command prompt inside of the file.
  3. Clone the framework by running git clone https://github.com/8char/AtlasFramework.git && cd AtlasFramework
  4. Run the transpile.bat file!
    • When the console stops printing lines, it should be fully compiled.

Credits

This repository is a fork of XeninUI, a popular user interface framework for Garry's Mod. While XeninUI has largely been abandoned, this fork aims to improve upon the documentation and the framework as a whole.

By updating the documentation and fixing any lingering bugs or issues, we hope to make XeninUI more accessible and usable for the Garry's Mod community. We also plan to add new features and functionality to the framework, making it even more powerful and useful for developers.

So if you're a fan of XeninUI, be sure to check out this fork and see all the improvements we've made. And if you want to contribute to the project, we welcome any and all pull requests! Together, we can make XeninUI even better than it already is.

About

AtlasUI is a user interface framework that offers pre-made UI elements, unit testing, and utility functions for building efficient and effective glua addons. It also includes an object-relational mapping (ORM) tool for easy data management.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published