1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203 
<p align="center">
<img alt="Factorion-Logo which looks like a robot from futurama" src=".github/image_pixelart_transparent.png" width="128px">
</p>
<h1 align="center"> Factorion-bot </h1>
<p align="center">
A reddit bot replying to comments, containing factorials, with the solution.
This little fella is currently running on <b>r/mathmemes</b>, <b>r/unexpectedfactorial</b> and on <b>r/ProgrammerHumor</b>.
</p>
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Reddit API Credentials](#reddit-api-credentials)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Contributing](#contributing)
# Getting Started
Follow these steps to set up and run the Factorion bot on your local machine and account.
## Prerequisites
- **Rust** (latest stable version) - [Install Rust](https://www.rust-lang.org/tools/install)
- **Reddit Account** - To run the bot, you'll need a Reddit account. [Reddit](https://www.reddit.com/)
## Reddit API Credentials
###### You can go to [Reddit API Documentation](https://www.reddit.com/dev/api) to checkout all the different endpoints you can access.
1. We need `Application ID` and `Secret Key` so that Reddit can know about our app. [preferences/apps](https://www.reddit.com/prefs/apps)
2. Click the <b>are you a Developer?</b> button to start setting up the bot.
<details>
<summary>Screenshot</summary>
<img src="https://github.com/user-attachments/assets/140056ac-91ce-4178-8703-19451357adce" \>
</details>
3. Fill in the required details:
- **Name**: Choose a name for your bot.
- **App type**: Select **Script**.
- **Redirect URI**: Use `http://localhost:8080` (or any URI; it’s not used for script bots).
<details>
<summary>Screenshot</summary>
<img src="https://github.com/user-attachments/assets/2450994a-14cf-4f46-9f71-518ceb0c59f5" \>
</details>
4. After creating the app, you'll receive:
- `client_id` (listed under the app name)
- `client_secret`
- A `username` and `password` (for the Reddit account that created the app)
## Installation
You might need to install some build dependencies: openssl, gmp, m4, pkg-config
### With Cargo (crates.io)
```bash
cargo install --locked factorion-bot-reddit
```
### With Nix
Use the provided flake.
```bash
nix build github:tolik518/factorion-bot
# The binaries will be in result/bin
```
### With docker
Skip to [Running on a server](#running-on-a-server).
### Manually
Fork/Clone the repository and navigate to the project directory:
```bash
git clone https://github.com/tolik518/factorion-bot.git
cd factorion-bot
# To just build
cargo build -r
# The binaries will be in target/release
# To install
cargo install --path .
```
## Configuration
Create a `.env` file in the project root with the following variables:
```env
APP_CLIENT_ID=<your_client_id>
APP_SECRET=<your_client_secret>
REDDIT_USERNAME=<reddit_app_username>
REDDIT_PASSWORD=<reddit_app_password>
SLEEP_BETWEEN_REQUESTS=<sleep_time>
# example: SUBREDDITS=test:en:dont_check+testingground4bots:ru:no_note,termial+::shorten
SUBREDDITS=<subreddits>
#Or (not at the same time)
SUBREDDITS_FILE=<path_to_subreddits_config_json_file>
TERMIAL_SUBREDDITS=<subreddits_with_termials>
CHECK_MENTIONS=<check_mentions>
CHECK_POSTS=<check_posts>
MENTIONS_EVERY=<check_mentions_every_nth_loop>
POSTS_EVERY=<check_posts_every_nth_loop>
INFLUXDB_HOST=localhost:8889
INFLUXDB_BUCKET=factorion-test
INFLUXDB_TOKEN=<token>
FLOAT_PRECISION=<the_precision_floats_use> 1024
UPPER_CALCULATION_LIMIT=<maximum_number_to_precisely_calculate> 1000000
UPPER_APPROXIMATION_LIMIT=<maximum_number_to_approximate_exponent> 300
UPPER_SUBFACTORIAL_LIMIT=<maximum_number_to_precisely_calculate_subfactorial> 1000000
UPPER_TERMIAL_LIMIT=<maximum_number_to_precisely_calculate_termial_exponent> 10000
UPPER_TERMIAL_APPROXIMATION_LIMIT=<maximum_number_to_approximate_termial_bits> 1073741822
INTEGER_CONSTRUCTION_LIMIT=<maximum_integer_to_parse_exponent> 100000000
NUMBER_DECIMALS_SCIENTIFIC=<how_many_decimals_to_display> 30
LOCALES_DIR=<directory_containing_locale_json_files>
INFLUXDB_HOST=localhost:8889
INFLUXDB_BUCKET=factorion-test
INFLUXDB_TOKEN=<token>
RUST_LOG=<factorion_bot|info|debug|trace|error|warn>
```
Replace with the values you received from the Reddit App creation.
InfluxDB is optional and can be removed if not needed.
The limits, precision and number of decimals are optional, and will use default values if left away.
The `_EVERY` variables are optional and default to `1`.
They control how often posts/mentions are checked compared to comments.
Setting them to `0` will result in a crash.
Set `RUST_LOG` to `factorion_bot` to see all logs, or `error` to see only errors.
The optional subreddits file should contain subreddit configuration in the following format (an example):
```json
{
"test": {
"locale": "en"
},
"testingground4bots": {
"locale": "ru",
"commands": {
"termial": true,
"no_note": true
},
"mode": "All"
},
"": {
"commands": {
"shorten": true
}
}
}
```
## Usage
If built manually, run the bot with:
```bash
cargo run
```
Otherwise run the binary `factorion-bot-reddit`.
```bash
# If in path (cargo install)
factorion-bot-reddit
# If local nix build
result/bin/factorion-bot-reddit
```
### How does it work in Reddit?
1. Create a new user for the bot so it can be mentioned by `/u/<botname>`
2. Create a new subreddit `/r/<botname>` as a test play ground.
## Running on a server
The recommended way would be running the bot using docker.
```bash
git clone https://github.com/tolik518/factorion-bot
docker build -t factorion-bot .
# either create a network called `service-network` or remove the network if not needed
export VERSION=<your_version_here>
export SSH_PATH=<your_path_on_server>
docker compose up -d
```
# Contributing
Feel free to submit issues or pull requests if you would like to contribute to this project.
Help with ideas, math, code, documentation, translations, etc. is greatly appreciated.
If you are unsure about how to start, visit [Contributing](CONTRIBUTING.md)
## Nix Devshell
If you use nix you can use `nix develop` and/or nix-direnv to enter a devshell, that provides all dependencies.