mirror of
https://github.com/JustArchiNET/ArchiSteamFarm
synced 2024-11-10 07:04:27 +00:00
General cleanup
This commit is contained in:
parent
f3c3573b23
commit
78bb754a6e
4 changed files with 16 additions and 22 deletions
18
.gitignore
vendored
18
.gitignore
vendored
|
@ -4,25 +4,21 @@
|
|||
|
||||
# Ignore all config files
|
||||
ArchiSteamFarm/config
|
||||
GUI/config
|
||||
|
||||
# Include default config files
|
||||
# Include default pre-defined config files
|
||||
!ArchiSteamFarm/config/ASF.json
|
||||
!ArchiSteamFarm/config/example.json
|
||||
!ArchiSteamFarm/config/minimal.json
|
||||
|
||||
# Ignore local log
|
||||
# Ignore local log + debugging
|
||||
ArchiSteamFarm/log.txt
|
||||
GUI/log.txt
|
||||
|
||||
# Ignore local debugging
|
||||
ArchiSteamFarm/debug
|
||||
GUI/debug
|
||||
|
||||
# Ignore out
|
||||
out/
|
||||
# Ignore out folders for publishing
|
||||
out
|
||||
ArchiSteamFarm/out
|
||||
|
||||
# Crowdin CLI secret
|
||||
# Ignore crowdin CLI secret
|
||||
tools/crowdin-cli/crowdin_identity.yaml
|
||||
|
||||
#################
|
||||
|
@ -33,7 +29,7 @@ tools/crowdin-cli/crowdin_identity.yaml
|
|||
## files generated by popular Visual Studio add-ons.
|
||||
|
||||
# User-specific files
|
||||
.vs/
|
||||
.vs
|
||||
*.suo
|
||||
*.user
|
||||
*.sln.docstates
|
||||
|
|
|
@ -40,8 +40,6 @@ Pull requests are a bit different compared to issues, as in PR you're asking us
|
|||
|
||||
In general any pull request is welcome and should be accepted, unless there is a strong reason against it. A strong reason includes mainly only things we directly do not agree with, such as features that are against Steam ToS (like explained above), greatly against ASF scope, or likewise. If there is nothing severe enough to justify rejecting PR, we'll tell you how to fix it (if needed), so we can allow it in ASF. If you're improving existing codebase, rewriting code to be more efficient, clean, better commented - there is absolutely no reason to reject such PR, as long as it's correct. If you want to add a missing feature, and you're not sure if it should be included in ASF, for example because you're not sure if it fits ASF scope - it won't hurt to ask before spending your own time, preferably in **[Steam group](http://steamcommunity.com/groups/ascfarm/discussions/1/)** discussions, so we can evaluate the idea and give feedback instead of accepting/rejecting the concept which is usually happening with GitHub issues - after all you want to code it yourself, so you shouldn't use GitHub issues that are being used for expecting us to add things. Still, GitHub issues are for development part of ASF like stated above, so feel free to post an issue in which you'll ask if given feature would be accepted in PR, if you prefer that way instead of using the Steam group.
|
||||
|
||||
It can also be hard to keep in mind that ASF must remain compatible not only with standard .NET framework, but also with Mono - this is not an issue in most cases, but sometimes behaviour might be slightly different or lacking, which means that code should be smart enough to handle runtime differences if needed. Usually it's not a big problem, as we're also here to spot and fix Mono problems, but keeping that in mind is important during development - imagine if you coded entire WPF GUI app and forgot that Mono works only with Windows Forms - you don't want that to happen, right?
|
||||
|
||||
Every pull request is carefully examined by our continuous integration system - it won't be accepted if it doesn't compile properly or causes any test to fail. We also expect that you at least barely tested the modification you're trying to add, so we can be sure that it works. Consider the fact that you're not coding it only for yourself, but for thousands of users.
|
||||
|
||||
At the same time ASF is open-source project, developed mainly by **[JustArchi](https://github.com/JustArchi)**, but also by **[many other contributors](https://github.com/JustArchi/ArchiSteamFarm/graphs/contributors)**. It's not our purpose to make you problems or forbid you from improving it, especially if you have a decent idea how to do so, therefore don't be afraid of making a suggestion first, then implementing it, after your suggestion is accepted (valid). Even if it's not a perfect solution, as long as it works it can be merged and improved in the future, as improving existing code is much easier than writing it from scratch. Still, if you're sending a PR, we expect that you did your best in it code-wise, so make sure that you're proud of your code, same like we are proud of ASF.
|
||||
|
|
18
README.md
18
README.md
|
@ -1,7 +1,7 @@
|
|||
# ArchiSteamFarm
|
||||
|
||||
[![Build status (Windows)](https://img.shields.io/appveyor/ci/JustArchi/ArchiSteamFarm/master.svg?label=Windows&maxAge=60)](https://ci.appveyor.com/project/JustArchi/ArchiSteamFarm)
|
||||
[![Build status (Mono)](https://img.shields.io/travis/JustArchi/ArchiSteamFarm/master.svg?label=Mono&maxAge=60)](https://travis-ci.org/JustArchi/ArchiSteamFarm)
|
||||
[![Build status (Unix)](https://img.shields.io/travis/JustArchi/ArchiSteamFarm/master.svg?label=Unix&maxAge=60)](https://travis-ci.org/JustArchi/ArchiSteamFarm)
|
||||
[![License](https://img.shields.io/github/license/JustArchi/ArchiSteamFarm.svg?label=License&maxAge=86400)](./LICENSE-2.0.txt)
|
||||
[![GitHub release](https://img.shields.io/github/release/JustArchi/ArchiSteamFarm.svg?label=Latest&maxAge=60)](https://github.com/JustArchi/ArchiSteamFarm/releases/latest)
|
||||
[![Github downloads](https://img.shields.io/github/downloads/JustArchi/ArchiSteamFarm/latest/total.svg?label=Downloads&maxAge=60)](https://github.com/JustArchi/ArchiSteamFarm/releases/latest)
|
||||
|
@ -21,25 +21,25 @@
|
|||
|
||||
## Description
|
||||
|
||||
ASF is a C# application that allows you to farm steam cards using multiple steam accounts simultaneously. Unlike Idle Master which works only for one account at given time, requires steam client running in background, and launches additional processes imitiating "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 Mono support, which makes it possible to launch on any Mono-supported operating system, such as Windows, Linux or OS X. ASF is based on, and possible, thanks to [SteamKit2](https://github.com/SteamRE/SteamKit).
|
||||
ASF is a C# application that allows you to farm steam cards using multiple steam accounts simultaneously. Unlike Idle Master which works only for one account at given time, requires steam client running in background, and launches additional processes imitiating "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 .NET Core-supported operating system, such as Windows, Linux or OS X. ASF is possible thanks to gigantic amount of work done in marvelous [SteamKit2](https://github.com/SteamRE/SteamKit) library.
|
||||
|
||||
ASF doesn't require and doesn't interfere in any way with Steam client. In addition to that, it no longer requires exclusive access to given account, which means that you can use your main account in Steam client, and use ASF for farming the same account at the same time. If you decide to launch a game, ASF will get disconnected, and resume farming once you finish playing your game, being as transparent as possible.
|
||||
ASF doesn't require and doesn't interfere in any way with Steam client. In addition to that, it doesn't require exclusive access to given account, which means that you can use your main account in Steam client, and use ASF for idling the same account at the same time. If you decide to launch a game, ASF will get disconnected, and resume idling once you finish playing your game, being as transparent as possible during entire process.
|
||||
|
||||
---
|
||||
|
||||
### Core features
|
||||
|
||||
- Automatic farming of available games with card drops using any number of active accounts
|
||||
- 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
|
||||
- Complex error-reporting mechanism, allowing ASF to be smart and resume farming even in case of Steam or networking problems
|
||||
- Customizable cards farming algorithm which will push performance of cards farming to the maximum
|
||||
- Offline farming, allowing you to skip in-game status and not confuse your friends anymore
|
||||
- Complex error-reporting mechanism, allowing ASF to be smart and resume idling even in case of Steam or networking problems
|
||||
- Customizable cards idling algorithm which will push performance of card drops to the maximum
|
||||
- Offline idling, allowing you to skip in-game status and stop confusing your friends
|
||||
- Advanced support for alt accounts, including ability to redeem keys, redeem gifts, accept trades and more through a simple Steam chat
|
||||
- Support for latest Steam security features, including SteamGuard, SteamParental and Two-Factor authentication
|
||||
- Support for latest Steam security features, including SteamGuard, SteamParental and two-factor authentication
|
||||
- Unique ASF 2FA mechanism allowing ASF to act as a mobile authenticator (if needed)
|
||||
- StreamTradeMatcher integration allowing ASF to help you in completing your steam badges by accepting dupe trades
|
||||
- Full Mono support, cross-OS compatibility, official support for Windows, Linux and OS X
|
||||
- Rebased on .NET Core 2.0, cross-OS compatibility, official support for Windows, Linux and OS X
|
||||
- ...and many more!
|
||||
|
||||
---
|
||||
|
|
Binary file not shown.
Loading…
Reference in a new issue