Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nsswifter/commandlinegame
This project is a collection of command-line games implemented in Swift. that includes different types of games such as math games, bomb games, and flag games.
https://github.com/nsswifter/commandlinegame
Last synced: 7 days ago
JSON representation
This project is a collection of command-line games implemented in Swift. that includes different types of games such as math games, bomb games, and flag games.
- Host: GitHub
- URL: https://github.com/nsswifter/commandlinegame
- Owner: nsswifter
- License: mit
- Created: 2023-04-09T19:38:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-20T17:57:08.000Z (3 months ago)
- Last Synced: 2024-08-20T20:13:50.559Z (3 months ago)
- Language: Swift
- Size: 44.4 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Command-line Game
This project is a command-line game collection that includes different types of games such as math games, bomb defusing games, and flag-guessing games. The project is written in Swift and utilizes various programming concepts and skills, including Protocol-Oriented Programming (POP), Project organization and file structure (Clean Architecture), String manipulation using Result Builder and Extension and et cetera. The project also incorporates colorful and styled text output in the terminal to enhance the user experience (Terminal styling using ANSI escape codes).
## Table of Contents
- [Project Diagram](#project-diagram)
- [Games Lists](#games-lists)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributors)
- [License](#license)
## Project Diagram
```bash
.
├── CommandLineGame
│ ├── App
│ │ ├── Controller
│ │ │ └── GameController.swift
│ │ └── View
│ │ ├── MessageView.swift
│ │ └── ResultBuilder
│ │ └── PrintExpensiveString.swift
│ ├── Core
│ │ ├── Entity
│ │ │ ├── BombGame.swift
│ │ │ ├── FlagGame.swift
│ │ │ ├── Game.swift
│ │ │ └── MathGame.swift
│ │ ├── Extention
│ │ │ └── StringColorsAndStyles.swift
│ │ └── ValueObjects
│ │ └── GameColor.swift
│ └── main.swift
│
├── CommandLineGame.xcodeproj
│
├── Documentation
│ ├── bombGame.mov
│ ├── flagGame.mov
│ ├── intro.mov
│ ├── mathGame.mov
│ └── usage.mov
│
├── LICENSE
│
└── README.md
```
## Games Lists
The following games are currently included:
- [x] [MathGame](CommandLineGame/Core/Entity/MathGame.swift)
- [x] [BombGame](CommandLineGame/Core/Entity/BombGame.swift)
- [x] [FlagGame](CommandLineGame/Core/Entity/FlagGame.swift)
Each game has its own set of rules and gameplay mechanics. See the documentation in each respective file for more information.
> [!NOTE]
> You can change the content of `celebrateVictory()` function from [Game Controller](CommandLineGame/App/Controller/GameController.swift) to customize secret box's content. :gift:
## Installation
To install this project, simply clone the repository to your local machine:
```console
git clone https://github.com/mehdi2003karami/CommandLineGame.git
```
## Usage
To run the game via Xcode simply build and run it.
- Note: Make Sure that Terminal scheme is chosen.
To run the game via Terminal, navigate to the inner CommandLineGame directory and run the main.swift file for the game you wish to play:
```console
swiftc \
main.swift \
App/Controller/GameController.swift \
App/View/MessageView.swift \
App/View/ResultBuilder/PrintExpensiveString.swift \
Core/Entity/BombGame.swift \
Core/Entity/FlagGame.swift \
Core/Entity/Game.swift \
Core/Entity/MathGame.swift \
Core/Extention/StringColorsAndStyles.swift \
Core/ValueObjects/GameColor.swift
```
Then enter the below command to execute compiled file.
```bash
./main
```
## Contributors
Feel free to share your ideas or any other problems.
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
## License
`CommandLine Game` is released under an MIT license. See [LICENSE](LICENSE) for more information.