Skip to content

Latest commit

 

History

History
179 lines (125 loc) · 6.41 KB

README.md

File metadata and controls

179 lines (125 loc) · 6.41 KB
Raw

Anubis

Users

Anubis is a lightweight trials companion for the desktop. It's a tool that will help trials sherpa's and streamers when participating in the Trials of Osiris event in Destiny the Game.

Lookup of opposing teams

We fetch information of your opponents from the Bungie API, Guardian.GG and DestinyTrialsReport so you know exactly who you're up against.

Green screen Twitch overlays

The progress of your trials can be presented on stream by using our overlay page which we host on your computer.

And much more features are on it's way:

  • Twitch chat Engage with your audience through the app.
  • Twitch bot Dedicated bot that integrates with the API and allows the app to be controlled by your Twitch moderators.
  • Loadout and vault support. Switch weapons or a complete loadout at a click of a button.
  • NetDuma integration Connection quality, geo information will be neatly presented in the application.
  • Notifications Get notified in the app when people switch gear or loadout mid-match, when you get a new follower on twitch and what not.

That sounds pretty sweet, how do I get the app?

First of all, thanks for taking the effort to try the application. Any feedback good or bad is much appreciated. To install the application you need to download the correct build for Operating System. We currently support

  • Mac OS
  • Windows (32 and 64 bit)

The applications are uploaded to our releases page at:

https://github.com/DestinyTheGame/anubis/releases

Each version has a downloads section where you can select and download the application that matches your system.

Please note that we do not have auto updating setup yet, so you need to manually check if new builds are available by looking at our releases page. We also announce new builds in our discord release channel.

If you have issues installing the application either create an issue in our issue tracker or join us on discord.

Documentation

See the docs folder and if you need help setting up the application or have questions that are not answered by the docs please reach out on discord.

Developers

This repository holds the code for the application. We did write some additional projects to make this application tick. These projects are also Open Sourced under the destinythegame project:

  • destiny-api A JavaScript based API client that interacts with Bungie.net's API.
  • bungie-auth A JavaScript based OAuth sign-in flow for Bungie's weird OAuth 2 implementation.

If you are interested in the development of the app, want to receive updates on the progress or just want to chat with the fine folks that make it app, join our Discord server!

The application is build upon the Electron which allows us to build cross platform applications using JavaScript, HTML, and CSS. Electron uses Node.js and Chromium to build the application. So for development purposes we assume that you have the following development tools installed locally:

  • nodejs Our JavaScript environment
  • git So you can download the source from GitHub

And npm, but that is bundled with Node.js. Once you have all dependencies installed you can clone this project to your local disk. In your terminal enter:

git clone git@github.com:DestinyTheGame/anubis.git

Go to the directory and install all the dependencies using:

npm install .

Now that you have the source code and all the dependencies you can run the application in development mode by running the following command in your CLI:

npm run dev

This will start the Electron Render Application, Node.js server for data access and various of development scripts to allow hot-reloading of the application during development.

Releasing

Until the project has matured to a 1.0 release assume that every release contains breaking changes. We iterate at a rapid phase in order to release the features we want. During the development of these features it could be that we need to re-write some of our internals that break backward compatibility.

Once we've reached our 1.0.0 status the version numbers will follow semver 2.0 strictly. Meaning that the first number in the version indicates a Major release which is usually containing breaking changes. The second digit indicates a minor version which is used to indicate the release of new features and functionality. The last version number indicates the patch release. This is bumped for your everyday fixes.

Our current release platforms are:

  • Windows
  • Mac OSX

This is the following flow to create a new release:

  1. Make sure you have the latest code base
  2. Remove your node_modules folder from the directory
  3. Run npm install to get the latest dependencies.
  4. Test run the application using npm run dev
  5. If basic quality assurance has been done a release can be made
  6. Bump the version number package.json and git tag <version>.
  7. Push version number & tag to Github.

To generate builds for the platforms run:

npm run release

This creates a builds folder where it will place the various of builds. We use electron-packager to generate the releases. Once the builds are created double check if they are working as intended by opening the application.

Once the builds are completed you can edit the created tag on our releases page on GitHub. Upload the build, and write release notes so people know what was fixed or introduced. And announce the new release in our discord release channel.

Contributing

Thoughts, ideas, fixes, brain farts and pull requests are encouraged in this project. Please create a GitHub account and create issues in our issue tracker:

Hang out in our discord channel to discuss features, bugs or help.

License

The source code is released as MIT, Bungie, Destiny The Game are trademarks owned by Bungie. Don't sue me.