Expect a few things to break here and there

ScrollWise AI

ScrollWise AI is an open-source AI-powered writing assistant that helps authors create, manage, and analyze their stories. It provides comprehensive worldbuilding tools, character development features, and AI-assisted content generation.

🌟 Features

Story Management

• Create and organize multiple writing projects
• Chapter management and organization
• Import existing documents (PDF, DOCX)
• Real-time content editing and saving

AI-Powered Tools

• Character development assistance
• Worldbuilding generation
• Plot consistency checking
• Relationship analysis between characters
• Knowledge base generation from your content

Codex System

• Maintain a detailed story bible
• Track characters, locations, items, and lore
• Automatic codex entry generation from your writing
• Relationship mapping between story elements

Cross-Platform

• Available for Windows only (Cross-platform coming soon)

Some Previews

Project Management

Codex Entries

Codex Generation

Login

🚀 Getting Started

Prerequisites

• Flutter SDK >=3.1.3
• Python 3.8+
• PostgreSQL (optional, SQLite supported by default)

Installation

1. Clone the repository:

git clone https://github.com/LotusSerene/scrollwise-ai.git
cd scrollwise-ai

2. Install backend dependencies:

cd backend
pip install -r requirements.txt

3. Install frontend dependencies:

cd frontend
flutter pub get

4. Configure environment variables: Create a .env file in both backend and frontend directories with necessary configurations.

5. Run the application:

# Start backend server
cd backend
python server.py

# Start frontend (in a new terminal)
cd frontend
flutter run

🛠️ Technology Stack

Frontend

• Flutter/Dart
• Provider for state management
• Material Design
• HTTP for API communication

Backend

• FastAPI
• SQLAlchemy
• LangChain
• ChromaDB for vector storage
• Gemini AI API

🤝 Contributing

We welcome contributions! You can contribute to the project by creating a pull request.

Development Setup

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0) - see the LICENSE file for details.

This means:

• ✅ You can use the software freely
• ✅ You can modify the software
• ✅ You can distribute the software
• ✅ You can use it commercially
• ❗ You must disclose source code when you distribute or serve the software
• ❗ You must state changes you make to the code
• ❗ You must license derivative works under AGPL-3.0

🌐 Links

• Official Website
• Discord
• Changelog

💝 Support the Project

ScrollWise AI is and will always be free and open source. If you'd like to support the project:

• ⭐ Star the repository
• 🐛 Report bugs and contribute fixes
• 📖 Improve documentation
• 🎨 Contribute new features

📊 Project Status

ScrollWise AI is under active development.