Giter Site home page Giter Site logo

reguilded-website's Introduction

ReGuilded Logo Chat on Guilded Open Issues WakaTime Chat on Guilded

ReGuilded is a client injector/client mod that allows you to extend the functionality of Guilded's client by providing theme and addon support.

NOTE: ReGuilded isn't fully stable and you may encounter some bugs or shortcomings. We are looking for more contributors working on ReGuilded.

Installation

You can use the Easy Installer located on our website. Alternatively, you can also download it from github.

Will you get banned for using ReGuilded?

ReGuilded is not associated with Guilded in any capacity. We have sought permission, and Guilded has confirmed that it will take no action using ReGuilded. However, abusing the mod using plugins or any other means to violate Guilded TOU could result in your account being banned.

Be sure to also read our license.

Contributing

Pull requests and Issues are welcome. You may want to coordinate with us on our Guilded Server in advance.

You can get the project's dependencies by running npm i in the repositories' root folder.

Steps for testing:

  1. Run npm run inject - This will run npm run build and npm run injectbare which will automatically put the asar into the right folder.
  2. There are two ways to update this asar after injecting:
    1. Running npm run inject - This will build, then uninject and inject.
    2. Copy the reguilded.asar in the out directory to one of the following directories.
      1. Linux: /user/local/share/ReGuilded
      2. Mac: /Applications/ReGuilded
      3. Windows: %PROGRAMFILES%/ReGuilded
  3. After updating the asar file you can press CTRL/CMD + R while focused on Guilded and the changes you made will be loaded.

Project Status

As mentioned at the top of this document, ReGuilded is currently under active development and is not fully stable yet. Please leave suggestions and ideas in the Community Tab or our Guilded Server. Contributions are welcome.

Credits

Our Patcher code is influenced by Powercord's Patcher Code, all credit goes to them for this file.

License

ReGuilded is licensed under the MPL 2.0 license.

reguilded-website's People

Contributors

atomisadev avatar codeize avatar crowdin-bot avatar dependabot[bot] avatar firecontroller1847 avatar idkgoodname avatar itznxthaniel avatar zaida04 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

reguilded-website's Issues

i18n Language Detection & Routing could use more work.

When a user's language on their browser doesn't have a specified region, the detection/routing fails to route them to a localized language on the website. For example:
Users Language "fr", website fails to redirect to "fr-FR"

Add skeleton loading to make website snappier.

At the moment the website doesn't load pages till items are fetched and ready to display. I'd prefer to make pages load instantly with skeleton components and then reveal the contents when they're ready. To provide more visual to the user than just the taskbar that stuff is loading.

Creator Dashboard

Allowing users to log in with SSO and access their creator dashboard. Based on the user's certain features are allowed. Project Leads should have access to Accept/Deny new Enhancements, and Review Updated Enhancements.

Progress on this can't begin until #40 is closed and finished.

Features to include:

  • Logging in/Loading Session
    • User should be created in the database if they don't have an account or loaded if they do.
  • User Profile. Allow users to upload a profile picture, and set flairs to show (based on roles in the dashboard).
  • User Roles (roles that should allow actions based on a permission-ish system)
    • Core Developer
    • Enhancement Reviewer
    • Enhancement Developer
    • RG Project Contributor
    • RG Supporter
  • Documentation
    • Creating Enhancements
      • Themes
      • Addons
      • Sounds
      • Bundling and submitting Enhancement Packs
      • Manual installation of ReGuilded

The eventual idea is that the user needs to link their Dashboard account with their Guilded Account. So we can fetch their roles to generate badges & flairs on RG. Instead of loading a big JSON. We fetch roles from RG API using the user's ID that is loading on Guilded.

Add stats to website.

I want to include some stats of RG on the website:

  • RG Server Member Count.
  • GitHub Release Downloads over 30days
  • A way to note how many users are using RG without intruding tracking data and no data retention.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.