Skip to content
This repository has been archived by the owner on Jul 5, 2018. It is now read-only.

Latest commit

 

History

History
159 lines (107 loc) · 6.41 KB

README.md

File metadata and controls

159 lines (107 loc) · 6.41 KB
Raw

salien-script-js

👽 A easy to install, run and update Node.js script for the Steam salien mini-game.

A Node.js implementation of https://github.com/SteamDatabase/SalienCheat by xPaw with additional features!

npm CI Status Coveralls Status Dependencies Dev Dependencies

🌈 Features

Note: We'll try our best to keep this version up to date with the PHP and other versions! Suggestions welcome.

🕹️ How to use this

  1. Install Node.js. (Version 10 and above)
  2. Log into Steam in your browser.
  3. Open the following URL: https://steamcommunity.com/saliengame/gettoken. You should be able to find the bit that looks like "token":"xxxxxxxx". Copy whatever is inside the second quotes, (e.g. xxxxxxxx).
  4. Open PowerShell on Windows. (Tip: Start > Run > type powershell.exe > Enter)
  5. Run npm install -g salien-script-js to install this project.
  6. Run the script by typing salien-script-js --token xxxxxxxx where xxxxxxxx is your token from step 3.

Remeber to drop us a ⭐ star on the project if you appreciate this script!

😍 How to update the script

  1. Close/cancel any running script windows
  2. Open PowerShell on Windows.
  3. Run npm i -g salien-script-js
  4. Re-run your scripts using the same command

Easy right?

👌 Represent your Steam Group (Optional)

If you'd like to represent a specific steam group, simply pass the --group option with the ID of the group.

salien-script-js --token xxxxxxxx --group 123456789

You can get your group id by going to https://steamcommunity.com/groups/YOUR_GROUP_NAME_HERE/memberslistxml/?xml=1 and replacing YOUR_GROUP_NAME_HERE with the group name shown at the end of your groups url.

You must be a member of a group to represent that group!

If you'd like to team up with an established larger group please consider using either:

👥 Multiple tokens/scripts

Simply open another PowerShell window and run salien-script-js --token yyyyyyyy --name "name of this script" where yyyyyyyy is your other accounts token and name of this script if what you'd like to see in the log outputs.

Advanced: CLI Arguments

  Usage:
    salien-script-js [options]

  Options:
    --token, -t           Your Saliens game token.
    --group, -g           (Optional) The ID of a steam group you'd like to represent.
    --name, -n            (Optional) The name to display on this instance of the script.
    --logRequests, -l     (Optional) Set to true if you'd like to show Steam API requests in the logs.

Advanced: 📦 Usage as an npm package

const SalienScript = require('salien-script-js');

const config = {
  token: '', // Your token from https://steamcommunity.com/saliengame/gettoken
  clan: '', // (optional) Clan id from https://steamcommunity.com/groups/YOUR_GROUP_NAME_HERE/memberslistxml/?xml=1
  name: '', // (optional) Name of this instance for logging
};

const salien = new SalienScript(config);

salien.init();

Advanced: 🐳 Running as a Docker container

The provided Dockerfile allows you to build this repository as a Docker container. To do that, clone the following repo and run the following commands.

# builds an image of the repo
$ docker build -t salien-script-js .

# sets up a container based on said image in "detached" mode
$ docker run -d --name salien-script-js salien-script-js [options]

You can also set up continuous deployment through Docker Hub. Read the following comment for a guide.

👨‍💻 Contributing and Development

Want to help out? Awesome! 👍

Pull the repo and you can run the script with node cli.js -t TOKEN.

PRs, suggestions, fixes and improvements all welcome.

License

This project is licensed under MIT

MIT License

Copyright (c) 2018 Alex Gabites

https://github.com/South-Paw/salien-script-js

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.