An open API service indexing awesome lists of open source software.

https://github.com/toasterbirb/rs-flip

[MIRROR] RuneScape flipping utility to make GE standing more profitable
https://github.com/toasterbirb/rs-flip

Last synced: over 1 year ago
JSON representation

[MIRROR] RuneScape flipping utility to make GE standing more profitable

Awesome Lists containing this project

README

          

# RS-Flip
RS-Flip is a CLI utility to help with flipping in RuneScape. The core features include calculating the profits and saving on-going and past flips.

## Usage
```
SYNOPSIS
rs-flip tips [-t ] [-c ] [-r ] [-g]
rs-flip calc -b -s -l
rs-flip add -i -b -s -l [-a ]
rs-flip sold -i [-s ] [-l ]
rs-flip cancel -i
rs-flip update -i [-b ] [-s ] [-l ] [-a ]
rs-flip list []
rs-flip filter ([-i ] | [-c ])
rs-flip stats [-c ]
rs-flip repair
rs-flip help
rs-flip test

OPTIONS
recommend flips based on past flipping data
tips mode
-t profit threshold
-c maximum result count
-r maximum random flip suggestion count (def: 0)
-g print the results in ge-inspector pre-filter list format

calculate the margin for an item and possible profits
calc mode
-b insta buy price
-s insta sell price
-l buy limit for the item

add a flip to the database
add mode
-i item name
-b buying price
-s assumed future selling price
-l item count to buy (usually the buy limit or slightly below)
-a the name of the account used for the flip

finish an on-going flip
sold mode
-i the id number can be found with the 'list' command
-s final selling price
-l final amount of items sold

cancels an on-going flip and removes it from the database
cancel mode
-i the id of the flip to cancel

update the details of an on-going flip
update mode
-i the id of the flip to update
-b new buying price
-s new selling price
-l new item count
-a new account name

list all on-going flips with their ids, buy and sell values
list mode
list only flips made with this account

look for items with filters
filter mode
-i find stats for a specific item
-c find flips that have been done count <= times

print out profit statistics
stats mode
-c set the amount of values to show

repair attempts to repair the statistics from the flip data in-case of some
bug

help show help
test run unit tests
```

To ignore specific item recommendations, add the item names one per line to `~/.local/share/rs-flip/item_blacklist.txt`

## Dependencies
- [doctest](https://github.com/doctest/doctest)
- [json](https://github.com/nlohmann/json)

## Compiling
```sh
mkdir build
cd build
cmake ..
make -j$(nproc)
```