30 |
56 |
31 |
38 |
32 |
33 |
34 |
35 |
36 |
37 | Twitch points miner
39 |
40 |
54 |
55 | 
5 | 
6 | 
7 | 
8 |
3 |
4 |
5 |
12 | A very lightweight twitch points miner, using only a few MB of ram, inspired by Twitch-Channel-Points-Miner-v2. 13 |
14 | 15 |  16 | 17 | ## Features 18 | * Web UI to interact with the app, and change configurations at runtime [screenshots](#Web-UI-screenshots) 19 | * Auto place bets on predictions 20 | * Watch stream to collect view points 21 | * Claim view point bonuses 22 | * Follow raids 23 | * REST API to manage app (Swagger docs at /docs) 24 | * Analytics logging all actions 25 | 26 | ## Configuration 27 | Check [example.config.yaml](example.config.yaml) for an example configuration. 28 | 29 | For a complete list of all configuration possibilities, check [common/src/config](common/src/config). 30 | 31 | Use the log level `info` for adequate information. Use `debug` for detailed logs, or if you feel a bug is present. 32 | 33 | ## Docker image 34 | This is the suggested way of using twitch-points-miner. 35 | 36 | Pull [t348575/twitch-points-miner](https://hub.docker.com/r/t348575/twitch-points-miner), be sure to pass your config file, and a volume for your `tokens.json`, as well as appropriate CLI arguments. 37 | 38 | Run with stdin attached the first time, in order to authenticate your twitch account. 39 | ``` 40 | docker run -i -t -v ./data:/data t348575/twitch-points-miner --token /data/tokens.json 41 | ``` 42 | Once it is running and the login flow is complete, CTRL+C then just attach the tokens file in subsequent runs. 43 | 44 | ## Docker compose 45 | An example docker compose file 46 | ```yaml 47 | services: 48 | twitch-points-miner: 49 | container_name: twitch-points-miner 50 | image: t348575/twitch-points-miner:latest 51 | volumes: 52 | - ./data:/data 53 | - ./config.yaml:/config.yaml # change this if needed to your config file 54 | command: 55 | - -t 56 | - /data/tokens.json 57 | - --analytics-db 58 | - /data/analytics.db 59 | - --log-file 60 | - /data/twitch-points-miner.log 61 | ports: 62 | - 3000:3000 # Web UI port 63 | environment: 64 | - LOG=info 65 | ``` 66 | 67 | ## Windows 68 | Has not been tested on windows, but should work fine 69 | 70 | ## Building 71 | ``` 72 | cargo build --release 73 | ``` 74 | 75 | ## Web UI screenshots 76 |  77 |  78 |  79 |  80 | -------------------------------------------------------------------------------- /app.dockerfile: -------------------------------------------------------------------------------- 1 | FROM oven/bun:slim as frontend 2 | WORKDIR /frontend 3 | COPY frontend /frontend 4 | RUN bun install 5 | RUN bun run build 6 | 7 | FROM t348575/muslrust-chef:1.77.1-stable as chef 8 | WORKDIR /tpm 9 | 10 | FROM chef as planner 11 | ADD app app 12 | ADD common common 13 | COPY ["Cargo.toml", "Cargo.lock", "."] 14 | RUN perl -0777 -i -pe 's/members = \[[^\]]+\]/members = ["app", "common"]/igs' Cargo.toml 15 | RUN cargo chef prepare --recipe-path recipe.json 16 | 17 | FROM chef as builder 18 | COPY --from=planner /tpm/recipe.json recipe.json 19 | ARG RUSTFLAGS='-C strip=symbols -C linker=clang -C link-arg=-fuse-ld=/usr/local/bin/mold' 20 | RUN RUSTFLAGS="$RUSTFLAGS" cargo chef cook --release --recipe-path recipe.json 21 | ADD app app 22 | ADD common common 23 | COPY ["Cargo.toml", "Cargo.lock", "."] 24 | RUN perl -0777 -i -pe 's/members = \[[^\]]+\]/members = ["app", "common"]/igs' Cargo.toml 25 | RUN RUSTFLAGS="$RUSTFLAGS" cargo build --release --target x86_64-unknown-linux-musl 26 | 27 | FROM scratch AS runtime 28 | COPY --from=frontend /dist /dist 29 | WORKDIR / 30 | ENV LOG=info 31 | COPY --from=builder /tpm/target/x86_64-unknown-linux-musl/release/twitch-points-miner /app 32 | EXPOSE 3000 33 | ENTRYPOINT ["/app"] -------------------------------------------------------------------------------- /app/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "twitch-points-miner" 3 | version = "0.1.11" 4 | edition = "2021" 5 | resolver = "2" 6 | 7 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 8 | 9 | [dependencies] 10 | serde = { version = "1", features = ["derive"] } 11 | serde_json = "1" 12 | tokio = { version = "1", features = ["full"] } 13 | indexmap = { version = "2.2", features = ["serde"] } 14 | tracing = "0.1" 15 | tracing-subscriber = { version = "0.3", features = ["env-filter", "chrono"] } 16 | twitch_api = { features = ["tpm", "utoipa"], default-features = false, git = "https://github.com/t348575/twitch_api", branch = "hidden_pubsubs" } 17 | clap = { version = "4.5", features = ["derive", "std", "help"], default-features = false } 18 | eyre = "0.6" 19 | rand = "0.8" 20 | serde_yaml = "0.9" 21 | chrono = { version = "0.4", features = ["serde"] } 22 | axum = "0.7" 23 | libsqlite3-sys = { version = "0.28", features = ["bundled"], default-features = false } 24 | diesel = { version = "2", features = ["sqlite", "chrono"] } 25 | diesel_migrations = { version = "2", features = ["sqlite"] } 26 | thiserror = "1" 27 | utoipa = { version = "4", features = ["axum_extras", "chrono"] } 28 | utoipa-swagger-ui = { version = "6", features = ["axum"] } 29 | tower-http = { version = "0.5", features = ["trace", "cors", "fs"] } 30 | tracing-appender = "0.2" 31 | flume = "0.11" 32 | common = { path = "../common", features = ["web_api"] } 33 | http = "1.1.0" 34 | ansi-to-html = "0.2" 35 | 36 | [dev-dependencies] 37 | common = { path = "../common", features = ["web_api", "testing"] } 38 | rstest = "0.19" 39 | reqwest = { version = "0.12", default-features = false, features = ["rustls-tls", "json"] } 40 | 41 | [[bin]] 42 | name = "twitch-points-miner" 43 | path = "src/main.rs" 44 | 45 | # [[bin]] 46 | # name = "default-config" 47 | # path = "src/default_config.rs" 48 | -------------------------------------------------------------------------------- /app/diesel.toml: -------------------------------------------------------------------------------- 1 | # For documentation on how to configure this file, 2 | # see https://diesel.rs/guides/configuring-diesel-cli 3 | 4 | [print_schema] 5 | file = "src/analytics/schema.rs" 6 | custom_type_derives = ["diesel::query_builder::QueryId"] 7 | 8 | [migrations_directory] 9 | dir = "migrations" 10 | -------------------------------------------------------------------------------- /app/migrations/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/t348575/twitch-points-miner/ae9d39d3d10ff8240f24e2529fe7cf6dd701db66/app/migrations/.keep -------------------------------------------------------------------------------- /app/migrations/2024-04-01-111509_create_streamers/down.sql: -------------------------------------------------------------------------------- 1 | DROP TABLE streamers; -------------------------------------------------------------------------------- /app/migrations/2024-04-01-111509_create_streamers/up.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE streamers ( 2 | id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, 3 | name TEXT NOT NULL 4 | ); -------------------------------------------------------------------------------- /app/migrations/2024-04-01-111659_create_points/down.sql: -------------------------------------------------------------------------------- 1 | DROP TABLE points; -------------------------------------------------------------------------------- /app/migrations/2024-04-01-111659_create_points/up.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE points ( 2 | id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, 3 | channel_id INTEGER NOT NULL, 4 | points_value INTEGER NOT NULL, 5 | points_info TEXT NOT NULL, 6 | created_at TIMESTAMP NOT NULL, 7 | FOREIGN KEY (channel_id) 8 | REFERENCES streamers (id) 9 | ); -------------------------------------------------------------------------------- /app/migrations/2024-04-06-102702_create_predictions/down.sql: -------------------------------------------------------------------------------- 1 | DROP TABLE predictions; -------------------------------------------------------------------------------- /app/migrations/2024-04-06-102702_create_predictions/up.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE predictions ( 2 | id INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, 3 | channel_id INTEGER NOT NULL, 4 | prediction_id TEXT NOT NULL, 5 | title TEXT NOT NULL, 6 | prediction_window BIGINT NOT NULL, 7 | outcomes TEXT NOT NULL, 8 | winning_outcome_id TEXT, 9 | placed_bet TEXT NOT NULL, 10 | created_at TIMESTAMP NOT NULL, 11 | closed_at TIMESTAMP, 12 | FOREIGN KEY (channel_id) 13 | REFERENCES streamers (id) 14 | ) -------------------------------------------------------------------------------- /app/src/analytics/model.rs: -------------------------------------------------------------------------------- 1 | use chrono::NaiveDateTime; 2 | use diesel::{ 3 | deserialize::FromSql, 4 | prelude::*, 5 | serialize::{IsNull, ToSql}, 6 | sql_types::Text, 7 | sqlite::{Sqlite, SqliteValue}, 8 | AsExpression, FromSqlRow, 9 | }; 10 | use serde::{de::DeserializeOwned, Deserialize, Serialize}; 11 | 12 | #[derive( 13 | Queryable, Identifiable, Selectable, Insertable, Debug, PartialEq, Clone, Serialize, Deserialize, 14 | )] 15 | #[diesel(table_name = super::schema::streamers, primary_key(id))] 16 | pub struct Streamer { 17 | pub id: i32, 18 | pub name: String, 19 | } 20 | 21 | #[derive( 22 | Queryable, 23 | Selectable, 24 | Insertable, 25 | Debug, 26 | PartialEq, 27 | Clone, 28 | Serialize, 29 | Deserialize, 30 | QueryableByName, 31 | utoipa::ToSchema, 32 | )] 33 | #[diesel(table_name = super::schema::points)] 34 | pub struct Point { 35 | pub channel_id: i32, 36 | pub points_value: i32, 37 | #[diesel(sql_type = Text)] 38 | pub points_info: PointsInfo, 39 | pub created_at: NaiveDateTime, 40 | } 41 | 42 | #[derive( 43 | Debug, Clone, Deserialize, Serialize, PartialEq, FromSqlRow, AsExpression, utoipa::ToSchema, 44 | )] 45 | #[diesel(sql_type = Text)] 46 | pub enum PointsInfo { 47 | FirstEntry, 48 | Watching, 49 | CommunityPointsClaimed, 50 | /// prediction event id 51 | Prediction(String, i32), 52 | } 53 | 54 | #[derive( 55 | Debug, Clone, Deserialize, Serialize, PartialEq, FromSqlRow, AsExpression, utoipa::ToSchema, 56 | )] 57 | #[diesel(sql_type = Text)] 58 | pub struct Outcomes(pub Vec{getKey(item)}
88 |{item}
114 | {#if $streamers.find((x) => x.data.info.live && x.data.info.channelName == item) !== undefined} 115 | 118 | {/if} 119 | 120 | 121 |
12 |
27 | {@html text}
28 |
29 | {page + 1}
49 | 57 |Default odds
94 |