# N7 Knowledge Base
<div align="center">
```
███╗ ██╗███████╗ ██████╗ █████╗ ████████╗ █████╗ ██████╗ █████╗ ███████╗███████╗
████╗ ██║╚════██║ ██╔══██╗██╔══██╗╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔════╝
██╔██╗ ██║ ██╔╝ ██║ ██║███████║ ██║ ███████║██████╔╝███████║███████╗█████╗
██║╚██╗██║ ██╔╝ ██║ ██║██╔══██║ ██║ ██╔══██║██╔══██╗██╔══██║╚════██║██╔══╝
██║ ╚████║ ██║ ██████╔╝██║ ██║ ██║ ██║ ██║██████╔╝██║ ██║███████║███████╗
╚═╝ ╚═══╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝╚══════╝
```
**A comprehensive Mass Effect knowledge base terminal UI application**
*Explore the rich lore of the Mass Effect trilogy from your terminal*
[](https://www.rust-lang.org/)
[](LICENSE)
</div>
---
## 📖 Overview
N7 Knowledge Base is a terminal user interface (TUI) application built with Rust and Ratatui that provides an immersive way to explore Mass Effect universe lore. Navigate through detailed information about races, places, ships, and characters from the beloved trilogy.
### ✨ Features
- 🎨 **Mass Effect themed interface** - Holographic cyan, Alliance orange, and tech blue color scheme
- 🗂️ **Four knowledge categories** - Races, Places, Ships, and Characters
- 🔍 **Real-time search** - Instantly filter entries as you type
- 📱 **Responsive UI** - Adapts to your terminal size
- ⌨️ **Intuitive controls** - Vim-style keybindings and arrow key navigation
- 📚 **Rich content** - Detailed descriptions, specifications, and history
- 🎯 **No dependencies** - Self-contained data files
- ⚡ **Fast and lightweight** - Built with Rust for performance
---
## 🚀 Installation
### Prerequisites
- Rust 1.70 or higher
- A terminal that supports 256 colors
### From Source
```bash
# Clone the repository
git clone https://github.com/x8code/n7.git
cd n7
# Build and run
cargo run --release
```
### Binary Release
Download the latest binary from the [releases page](https://github.com/x8code/n7/releases).
---
## 🎮 Usage
Launch the application:
```bash
n7
```
Or using cargo:
```bash
cargo run --release
```
### Keyboard Controls
#### Navigation
- `↑` / `k` - Move up in list
- `↓` / `j` - Move down in list
- `←` / `h` - Previous category
- `→` / `l` / `Tab` - Next category
- `Enter` - View details / Return to list
#### Search
- `/` - Start search mode
- `Esc` - Cancel search
- `Enter` - Apply search filter
#### General
- `?` - Toggle help screen
- `q` / `Esc` - Quit application
- `Ctrl+C` - Force quit
---
## 📚 Content Categories
### 🔷 Races
Explore the major species of the Mass Effect universe:
- Asari, Turians, Salarians, Krogan
- Humans, Quarians, Geth, Protheans
- Biology, culture, government, and notable individuals
### 🌟 Places
Discover key locations across the galaxy:
- The Citadel, Omega, Illium
- Tuchanka, Thessia, Palaven
- Earth, Rannoch, Sur'Kesh
- History, features, and associated races
### 🚀 Ships
Learn about iconic vessels:
- Normandy SR-1 and SR-2
- Destiny Ascension
- Collector Cruiser, Geth Dreadnought
- Specifications, armament, and history
### 👤 Characters
Meet the heroes and villains:
- Commander Shepard and squad members
- Garrus, Liara, Tali, Wrex
- Mordin, Thane, Legion, and more
- Background, abilities, and appearances
---
## 🎨 Screenshots
```
┌─ N7 DATABASE ─────────────────────────────────────────────────────────────────┐
│ ◆ Races │ │
│ ★ Places │ Asari │
│ ▶ Ships │ ═══════ │
│ ● Characters │ │
│ │ Homeworld: Thessia │
│ │ │
│ │ Description: │
│ │ A mono-gendered race known for their long │
│ │ lifespans and biotic abilities... │
└─────────────────────────────────────────────────────────────────────────────┘
```
---
## 🛠️ Development
### Project Structure
```
n7/
├── src/
│ ├── main.rs # Entry point
│ ├── app.rs # Application loop
│ ├── state.rs # State management
│ ├── events.rs # Event handling
│ ├── ui/
│ │ ├── mod.rs # UI rendering
│ │ ├── theme.rs # Color theme
│ │ └── widgets.rs # Custom widgets
│ └── data/
│ ├── mod.rs
│ ├── models.rs # Data structures
│ └── loader.rs # JSON loading
└── data/
├── races.json
├── places.json
├── ships.json
└── characters.json
```
### Building
```bash
# Development build
cargo build
# Release build (optimized)
cargo build --release
# Run tests
cargo test
# Check code
cargo clippy
```
### Adding New Content
Edit the JSON files in the `data/` directory to add or modify entries. The structure is self-documenting - just follow the existing format.
---
## 🤝 Contributing
Contributions are welcome! Here's how you can help:
1. **Report bugs** - Open an issue describing the problem
2. **Suggest features** - Share your ideas for improvements
3. **Add content** - Submit PRs with additional lore entries
4. **Improve UI** - Enhance the visual design or UX
5. **Fix issues** - Check open issues and submit fixes
### Contribution Guidelines
- Follow Rust best practices and idioms
- Maintain the existing code style
- Add tests for new features
- Update documentation
- Keep commits focused and descriptive
---
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## ⚠️ Disclaimer
This is a fan-made project and is not affiliated with, endorsed by, or sponsored by BioWare or Electronic Arts. Mass Effect and all related properties are trademarks of BioWare/Electronic Arts.
---
## 🙏 Acknowledgments
- **BioWare** - For creating the amazing Mass Effect universe
- **Ratatui** - Excellent TUI framework for Rust
- **Mass Effect Wiki** - Source of lore information
- **Community** - All the fans who keep Mass Effect alive
---
## 📞 Contact
- GitHub: [@x8code](https://github.com/x8code)
- Issues: [GitHub Issues](https://github.com/x8code/n7/issues)
---
<div align="center">
**"I'm Commander Shepard, and this is my favorite TUI on the Citadel!"**
Made with ❤️ by the Mass Effect community
</div>