https://github.com/moeru-ai/airi-factorio
Helper for アイリ to play Factorio with you.
https://github.com/moeru-ai/airi-factorio
ai factorio factorio-mod llm typescript
Last synced: about 1 year ago
JSON representation
Helper for アイリ to play Factorio with you.
- Host: GitHub
- URL: https://github.com/moeru-ai/airi-factorio
- Owner: moeru-ai
- License: mit
- Created: 2025-01-17T14:07:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-17T17:28:47.000Z (over 1 year ago)
- Last Synced: 2025-03-24T22:02:26.954Z (about 1 year ago)
- Topics: ai, factorio, factorio-mod, llm, typescript
- Language: TypeScript
- Homepage:
- Size: 288 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# airi-factorio
Helper for アイリ to play Factorio with you.
> [!NOTE]
>
> This project is part of the [Project アイリ (Airi)](https://github.com/moeru-ai/airi), we aim to build a LLM-driven VTuber like [Neuro-sama](https://www.youtube.com/@Neurosama) (subscribe if you didn't!), if you are interested in, please do give it a try on [live demo](https://airi.moeru.ai).
## Development
### Project Structure
It's hard to describe the project structure in a few words, but it currently looks like this:
### Start to develop
1. Clone the repository:
```bash
git clone https://github.com/moeru-ai/airi-factorio
```
2. Install dependencies:
```bash
pnpm i
```
3. Create a symlink for the `autorio` mod:
```bash
cd /path/to/airi-factorio
ln -s /path/to/airi-factorio/packages/autorio/dist /path/to/factorio/data/autorio
# If you are using DevContainer, you can use the following command:
ln -s /workspace/airi-factorio/packages/autorio/dist /opt/factorio/data/autorio
```
4. Copy and fill the `.env` file:
```bash
cp packages/agent/.env.example packages/agent/.env.local
cp packages/factorio-wrapper/.env.example packages/factorio-wrapper/.env.local
```
If you are using DevContainer, you can set `WS_SERVER_HOST` and `FACTORIO_WS_HOST` and `RCON_API_SERVER_HOST` to `localhost`.
5. Create a game save file, the save file path should be the same as the one in the `.env` file:
```bash
/path/to/factorio/bin/x64/factorio --create /path/to/factorio/saves/save.zip
# If you are using DevContainer, you can use the following command:
/opt/factorio/bin/x64/factorio --create /path/to/factorio/saves/save.zip
# If your machine is not x64, you can use the following command:
box64 /opt/factorio/bin/x64/factorio --create /path/to/factorio/saves/save.zip
```
6. Run the development script:
```bash
pnpm run dev
```
Now you can use the commands in Factorio, the script will be compiled automatically, but you need to exit and re-enter the game to see the changes(no need to restart the game).
## Credits
Thanks for the original idea and code: https://github.com/naklecha/factorio-automation