mirror of
https://github.com/JustArchiNET/ArchiSteamFarm.git
synced 2026-01-01 14:10:53 +00:00
Move non-critical md resources into .github directory
This commit is contained in:
JustArchi
76
.github/README.md
vendored
Normal file
76
.github/README.md
vendored
Normal file
@@ -0,0 +1,76 @@
|
||||
# ArchiSteamFarm
|
||||
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/actions?query=branch%3Amaster)
|
||||
[](https://ci.appveyor.com/project/JustArchi/ArchiSteamFarm)
|
||||
[](https://travis-ci.com/JustArchiNET/ArchiSteamFarm)
|
||||
[](https://hub.docker.com/r/justarchi/archisteamfarm)
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/commits)
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/blob/master/LICENSE-2.0.txt)
|
||||
[](https://crowdin.com/project/archisteamfarm)
|
||||
|
||||
[](https://justarchinet.github.io/ASF-WebConfigGenerator)
|
||||
[](https://asf.justarchi.net)
|
||||
[](https://steamcommunity.com/groups/archiasf)
|
||||
[](https://discord.gg/hSQgt8j)
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/wiki)
|
||||
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/releases/latest)
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/releases/latest)
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/releases/latest)
|
||||
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/releases)
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/releases)
|
||||
[](https://github.com/JustArchiNET/ArchiSteamFarm/releases)
|
||||
|
||||
[](https://github.com/sponsors/JustArchi)
|
||||
[](https://www.patreon.com/JustArchi)
|
||||
[](https://www.paypal.me/JustArchi/5eur)
|
||||
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=HD2P2P3WGS5Y4)
|
||||
[](https://blockstream.info/address/bc1q8archy9jneaqw6s3cs44azt6duyqdt8c6quml0)
|
||||
[](https://steamcommunity.com/tradeoffer/new/?partner=46697991&token=0ix2Ruv_)
|
||||
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
ASF is a C# application with primary purpose of idling Steam cards from multiple accounts simultaneously. Unlike Idle Master which works only for one account at given time, while requiring Steam client running in the background and launching additional processes imitating "game playing" status, ASF doesn't require any Steam client running in the background, doesn't launch any additional processes and is made to handle unlimited Steam accounts at once. In addition to that, it's meant to be run on servers or other desktop-less machines, and features full cross-OS support, which makes it possible to launch on any operating system with .NET Core runtime, such as Windows, Linux and OS X. ASF is possible thanks to gigantic amount of work done in marvelous **[SteamKit2](https://github.com/SteamRE/SteamKit)** library.
|
||||
|
||||
Today, ASF is one of the most versatile Steam power tools, allowing you to make use of many features that were implemented over time. Apart from idling Steam cards, which remains the primary focus, ASF includes bunch of features on its own, such as a possibility to use it as Steam authenticator or chat logger. In addition to that, ASF includes plugin system, thanks to which anybody can further extend it to his/her needs.
|
||||
|
||||
---
|
||||
|
||||
### Core features
|
||||
|
||||
- Automatic idling of available games with card drops using any number of active accounts
|
||||
- No requirement of running or even having official Steam client installed
|
||||
- Guarantee of being VAC-free, focus on security and privacy
|
||||
- Complex error-reporting mechanism, reliability even during Steam issues and other networking quirks
|
||||
- Flexible cards idling algorithm, pushing the performance to the maximum while still allowing a lot of customization
|
||||
- Offline idling, enabling you to skip in-game status and stop confusing your friends with fake playing status
|
||||
- Advanced support for Steam accounts, including ability to redeem keys, redeem gifts, accept trades, send messages and more
|
||||
- Support for latest Steam security features, including SteamGuard, SteamParental and 2-factor authentication
|
||||
- Unique ASF 2FA mechanism allowing ASF to act as a mobile authenticator, if needed
|
||||
- STM-like integration for trades, both passive (accepting) and active (sending), ASF can help you complete your sets
|
||||
- Special plugin system, which allows you to extend ASF in any way you wish through your own code
|
||||
- Powered by .NET Core, cross-OS compatibility, official support for Windows, Linux and OS X
|
||||
- ...and many more!
|
||||
|
||||
For learning about even more ASF features, we recommend starting with our **[FAQ entry](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/FAQ#what-interesting-features-asf-offers-that-idle-master-does-not)**.
|
||||
|
||||
---
|
||||
|
||||
### Setting up / Help
|
||||
|
||||
Detailed guide regarding setting up and using ASF is available on our wiki in **[setting up](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Setting-up)** section. It's user-friendly guide that shows basic, as well as a bit more complex ASF setup, covering all the required dependencies and other steps that are required in order to start using ASF software.
|
||||
|
||||
---
|
||||
|
||||
### Compatibility / Supported operating systems
|
||||
|
||||
ASF officially supports Windows, Linux and OS X operating systems, but it can work anywhere where you can obtain working .NET Core runtime. Please visit **[compatibility](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Compatibility)** section on the wiki for more information regarding environments that ASF can work in.
|
||||
|
||||
---
|
||||
|
||||
### Want to know more?
|
||||
|
||||
Our **[wiki](https://github.com/JustArchiNET/ArchiSteamFarm/wiki)** includes a lot of other articles that will tell you about everything in regards to ASF, as well as show you other features that you can make use of. If you have some time to spare and you'd like to find out what else ASF can do for you, we heavily encourage you to take a look!
|
||||
17
.github/SECURITY.md
vendored
Normal file
17
.github/SECURITY.md
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# Security policy
|
||||
|
||||
---
|
||||
|
||||
## Supported versions
|
||||
|
||||
We support **[the latest stable](https://github.com/JustArchiNET/ArchiSteamFarm/releases/latest)** release only. In addition to that, limited support applies to **[the latest pre-release](https://github.com/JustArchiNET/ArchiSteamFarm/releases)** version (if available). Check out our **[release cycle](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Release-cycle)** for more info.
|
||||
|
||||
---
|
||||
|
||||
## Reporting a vulnerability
|
||||
|
||||
We're doing our best to protect our community from all harm, therefore we take security vulnerabilities very seriously.
|
||||
|
||||
If you believe that you've found one, we'd appreciate if you let us know about it. You can do so by contacting us privately at ASF@JustArchi.net e-mail, where we'll do our best to evaluate your issue ASAP and keep you updated with the development status. If your vulnerability isn't crucial and doesn't result in a direct escalation, therefore can be known publicly while the appropriate fix is being implemented, you can also open a standard **[issue](https://github.com/JustArchiNET/ArchiSteamFarm/issues/new/choose)** instead.
|
||||
|
||||
Depending on the severity of the issue, we might take further actions in order to limit potential damage, for example by speeding up the release of the next stable ASF version. This is evaluated on a case-by-case basis.
|
||||
7
.github/SUPPORT.md
vendored
Normal file
7
.github/SUPPORT.md
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
# Support
|
||||
|
||||
Our **[wiki](https://github.com/JustArchiNET/ArchiSteamFarm/wiki)** is the official online documentation which covers at least a significant majority (if not all) of ASF subjects you could be interested in. We recommend to start with **[setting up](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Setting-up)**, **[configuration](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/Configuration)** and our **[FAQ](https://github.com/JustArchiNET/ArchiSteamFarm/wiki/FAQ)** which should help you with setting up ASF, configuring it, as well as answering the most common questions that you might have. For more advanced matters, as well as further elaboration, we have other pages available on our **[wiki](https://github.com/JustArchiNET/ArchiSteamFarm/wiki)** that you can visit.
|
||||
|
||||
We also have two support channels dedicated to our ASF users, in case you couldn't manage to solve the issue yourself. We answer all support and technical matters on our **[Steam group](https://steamcommunity.com/groups/archiasf/discussions/1)**, which should be used for majority of the issues and questions, especially advanced ones. In addition to that, we have a **[Discord server](https://discord.gg/hSQgt8j)**, also known as "ASF chat", which is a good choice for more casual, simple questions. You're free to use the support channel that matches your preferences, although keep in mind that you have a higher chance solving your issue on the Steam group, where we're doing our best to answer all questions that couldn't be answered by our community itself (as opposed to ASF chat where we're not active 24/7 and therefore we're not able to help everybody).
|
||||
|
||||
GitHub **[issues](https://github.com/JustArchiNET/ArchiSteamFarm/issues)** page is being used for ASF development, especially in regards to bugs and enhancements. We have a very strict policy regarding that, as GitHub is **not** a general support channel, it's dedicated exclusively to ASF development and we're not answering common ASF matters there, as we have appropriate support channels (mentioned above) for that. Common matters include not only general questions or issues that are obviously related to program usage, but also users reporting "bugs" that are clearly considered intended behaviour coming for example (and mainly) from misconfiguration or lack of understanding how the program works. If you're not sure whether your matter relates to ASF development or not, especially if you're not sure if it's a bug or intended behaviour coming from misconfiguration or lack of understanding how the program works, we recommend to use a support channel instead, where we'll answer you and forward your matter to GitHub if deemed appropriate. Invalid GitHub issues will be closed immediately and won't be answered.
|
||||
Reference in New Issue
Block a user