Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 3.17 KB

README.md

File metadata and controls

90 lines (66 loc) · 3.17 KB
Raw

Atlas for Rust

discord twitter
donate on ko-fi donate bitcoin

What is Atlas

Atlas is an unofficial interactive map experience for Rust. It uses the same websocket protocol that the official Rust+ Companion app uses to communicate with the Rust game servers.

Features

  • Shows a realtime updating interactive map, including:
    • Hackable Crates
    • Cargo Ship
    • Chinook
    • Explosions
    • Vending Machines
    • Team Members
  • Shows realtime server stats
    • Current player count
    • How long since last wipe
  • Send and Receive realtime Team Chat messages
  • Search items for sale in Vending Machines across the map
  • Supports "Pairing" with Rust Servers from the in game menu
  • Supports adding Rust servers manually without using the in game pairing menu
    • Useful if you run your own server and have access to server files

Features to Implement

  • Map
    • Add custom markers with colour and name to the map
  • Smart Devices
    • Pair with Smart Devices
    • View list of Smart Devices per server
    • User could place custom markers on map showing where Smart Alarms are triggered
  • Atlas Auto Updater, currently users will need to update manually from GitHub releases

How to Install

  • Download the latest installer from Releases
  • After downloading, run AtlasForRust-x.y.z-win.exe
  • Connect with Rust+ from the Atlas welcome screen
  • Pair with your Rust server from the in game menu

How to build for development

Download and Install Dependencies

git clone https://github.com/liamcottle/atlas-for-rust.git
cd atlas-for-rust
npm install

Run Electron app for Development

npm run electron:serve

Build for Mac, Windows and Linux

At this stage, GitHub actions only builds and releases Windows versions of Atlas. However, if you want to run Atlas on Mac or Linux, you can use the command below.

npm run electron:build -- --mac --win --linux

Updating Rust Assets

Atlas uses images and metadata from the Rust game files. These can be updated with the update_assets.js script.

node update_assets.js "<drive>:\SteamLibrary\steamapps\common\Rust"

Contributing

If you have a feature request, or find a bug with Atlas, please open an issue here on GitHub.