The Sentient Sims app is an app that runs while you play the Sentient Sims mod.
The application is needed to be able to talk to the Open AI API securely. The Sims 4 developers did not include the necessary code to be able to securely send requests, which is needed to talk to the internet. If you dont have this, the communication is sent in plain text and anyone can intercept your data and read it.
The app also handles state and saves for the mod.
Checkout the wiki for more details.
Contributions are welcome, the app is open source.
Questions? Join the Discord!
- Node.js (v18)
- npm
To get this project up and running locally, follow these steps:
- Clone the repository:
git clone https://github.com/guspuffygit/sentient-sims-app.git
- Navigate to the project directory:
cd sentient-sims-app
- Install dependencies:
npm ci
To run the project locally:
npm run start
With the app running in development mode, you can play the mod at this point while making changes to the app.
To verify changes are linted correctly, run:
npm run lint
There are integration and unit tests that can be ran locally to verify changes.
Integration tests require an OpenAI API Key to be present in the environment variables for part of the test.
OPENAI_KEY=sk-***
npm run test:unit
npm run test
- Fork the repository
- Make changes as necessary
- Run the tests and verify linting is successful locally
- Open a PR