80 lines
2.3 KiB
Markdown
80 lines
2.3 KiB
Markdown
# BSC Score
|
|
|
|
A modern, responsive web application for tracking billiards scores. Built with vanilla JavaScript and designed for mobile-first usage.
|
|
|
|
## Features
|
|
|
|
- Track scores for different billiards game types (8-Ball, 9-Ball, 10-Ball, 14/1)
|
|
- Support for "Race to X" games
|
|
- Real-time score tracking
|
|
- Game history with active and completed games
|
|
- Player name history and quick selection
|
|
- Mobile-optimized touch interface
|
|
- Offline support with local storage
|
|
- Dark theme design
|
|
|
|
## Usage
|
|
|
|
1. Open `index.html` in your web browser
|
|
2. Create a new game by clicking "Neues Spiel"
|
|
3. Select or enter player names
|
|
4. Choose game type and optional "Race to X" setting
|
|
5. Use the score buttons to track points during the game
|
|
6. Complete the game when finished
|
|
7. View game history and filter by status
|
|
|
|
## Development
|
|
|
|
The application is built using:
|
|
- Vanilla JavaScript (ES6+)
|
|
- HTML5
|
|
- CSS3
|
|
- LocalStorage for data persistence
|
|
|
|
No build process or dependencies required. Simply clone the repository and open `index.html` in a web browser.
|
|
|
|
## Project Structure
|
|
|
|
The project consists of the following key files:
|
|
- `index.html`: Main application file containing HTML, CSS, and JavaScript
|
|
- `README.md`: Project documentation and setup instructions
|
|
- `LICENSE`: GNU GPLv3 license text
|
|
- `TODO.md`: Roadmap and planned features
|
|
|
|
## Features in Detail
|
|
|
|
### Core Features
|
|
- Score tracking for multiple billiards game types
|
|
- Player name history with quick selection
|
|
- Game status management (active/completed)
|
|
- Local storage for offline functionality
|
|
- Mobile-optimized interface
|
|
|
|
### User Interface
|
|
- Dark theme design
|
|
- Touch-friendly controls
|
|
- Responsive layout
|
|
- Game type selection
|
|
- Player name management
|
|
|
|
### Data Management
|
|
- Local storage persistence
|
|
- Game history tracking
|
|
- Player name history
|
|
- Status filtering
|
|
|
|
## Contributing
|
|
|
|
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
|
|
|
|
## Roadmap
|
|
|
|
See [TODO.md](TODO.md) for a list of proposed features and known issues.
|
|
|
|
## License
|
|
|
|
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details. |