Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@toshydev
toshydev authored Aug 21, 2023
1 parent 12d148d commit a9d31fa
Showing 1 changed file with 27 additions and 18 deletions.
45 changes: 27 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,40 +1,49 @@
[![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Ftoshydev%2FnetRunner&labelColor=%23343a40&countColor=%23ff004f&style=flat&labelStyle=lower)](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Ftoshydev%2FnetRunner)

**NetRunner**
![netRunner_wireframes](https://github.com/toshydev/netRunner/assets/91165689/cbec104c-7d1b-48d4-9f25-b37e960e40d4)
# Netwalker
![netwalker_showcase_8 4 2](https://github.com/toshydev/netRunner/assets/91165689/086c1db8-2cb6-487a-bcd9-c254c9867b0f)

**Summary:**
NetRunner is a unique real-world exploration game set in a cyberpunk-inspired universe. Players venture into the real world, utilizing their GPS positions to conquer nodes representing real-world landmarks and locations. In this multiplayer online game, players establish territorial control by connecting conquered nodes, generating in-game currency, and strategically upgrading nodes to increase resistance against rival players. Engaging in real-time multiplayer interactions, players can enter each other's territories to absorb credits and strengthen their dominance in the futuristic cityscape.

**Used Technologies, Frameworks, and Libraries:**
- Frontend: React with Vite, Axios, Zustand, Mapbox
- Backend: Spring Boot with Spring WebFlux, MongoDB
- Testing: JUnit, AssertJ, Mockito, MockMvc, Flapdoodle (for integration tests)
- Deployment: GitHub Actions for CI/CD, Docker
Netwalker is a unique real-world exploration game set in a cyberpunk-inspired universe. Players venture into the real world, utilizing their GPS positions to conquer nodes representing real-world landmarks and locations. In this multiplayer online game, players establish territorial control by connecting conquered nodes, generating in-game currency, and strategically upgrading nodes to increase resistance against rival players. Engaging in real-time multiplayer interactions, players can enter each other's territories to absorb credits and strengthen their dominance in the futuristic cityscape.

**Game Mechanics:**
1. **Real-World Exploration:** NetRunner utilizes players' GPS positions to allow them to explore the real world, conquering nodes at specific real-world locations and landmarks.
## Used Technologies, Frameworks, and Libraries:
- Frontend: React with Vite, Axios, Zustand, Mapbox, Leaflet, Emotion, Material-UI, Geolib
- Backend: Spring Boot with Spring Security, Spring Reactive Web, Spring Validation, MongoDB + MongoDB Atlas
- Testing: JUnit, AssertJ, Mockito, MockMvc, Flapdoodle
- Deployment: GitHub Actions for CI/CD, Docker, AWS, Raspberry Pi

2. **Territory Control:** Players establish territorial control by connecting conquered nodes, forming a network that generates in-game currency based on the player's real-world exploration.
## Game Mechanics:
1. **Real-World Exploration:** Netwalker utilizes players' GPS positions to allow them to explore the real world, conquering nodes at specific real-world locations and landmarks.

2. **Territory Control:** Players establish territorial control by connecting conquered nodes, forming a network that generates in-game currency based on the player's real-world exploration. (update coming soon)

3. **Resistance Upgrades:** Players can invest in node upgrades, boosting their resistance to attacks from other players. Upgraded nodes provide enhanced defense for the player's territory.

4. **Real-Time Multiplayer:** NetRunner offers real-time multiplayer interactions, enabling players to engage with each other's territories. Players can enter rival territories to absorb credits and strengthen their own holdings.
4. **Real-Time Multiplayer:** Netwalker offers real-time multiplayer interactions, enabling players to engage with each other's territories. Players can enter rival territories to absorb credits and strengthen their own holdings.

5. **User Authentication:** Players must register and log in to access the game's features. Spring Security ensures secure user authentication and management.

6. **Customizable Protagonist:** Players can personalize their in-game character, choosing the appearance, and theme to create a unique identity in the cyberpunk universe.
6. **Customizable Protagonist:** Players can personalize their in-game character, choosing the appearance, and theme to create a unique identity in the cyberpunk universe. (coming soon)

## Current State of the Project:
![netwalker_showcase_9 1 1](https://github.com/toshydev/netRunner/assets/91165689/9e7279a3-e970-4f5e-aeff-07b1c405515d)


**Current State of the Project:**
NetRunner is currently under development, with the frontend designed using React, Vite, and Mapbox to integrate the cyberpunk-themed interface with real-world map exploration based on players' GPS positions. The backend relies on Spring Boot, Spring WebFlux, and MongoDB to handle real-time multiplayer interactions, node data, and user profiles effectively. Comprehensive testing, utilizing JUnit, AssertJ, Mockito, and MockMvc, ensures stable and reliable gameplay.
Netwalker is currently under development, with the frontend designed using React, Vite, and Mapbox with Leaflet to integrate the cyberpunk-themed interface with real-world map exploration based on players' GPS positions. The backend relies on Spring Boot, Spring Security, Spring Reactive Web, Spring Validation and MongoDB Atlas to handle real-time multiplayer interactions, node data, and user profiles effectively. Comprehensive testing, utilizing JUnit, AssertJ, Mockito, and MockMvc, ensures stable and reliable gameplay.

The game mechanics focus on real-world exploration, territorial control, and resistance upgrades. Real-time multiplayer functionality is being developed, allowing players to interact with each other's territories and engage in credit absorption during territorial encounters.

The project's CI/CD pipeline, powered by GitHub Actions and Docker, facilitates automated testing and deployment to various environments, including Amazon, Heroku, and self-hosted servers.
The project's CI/CD pipeline, powered by GitHub Actions and Docker, facilitates automated testing and deployment to various environments, including Amazon, and self-hosted servers.

As development continues, NetRunner aims to provide an immersive experience, enabling players to explore the real world through the lens of a cyberpunk universe, strategize their territorial control, and engage in thrilling multiplayer encounters within the futuristic cityscape.
As development continues, Netwalker aims to provide an immersive experience, enabling players to explore the real world through the lens of a cyberpunk universe, strategize their territorial control, and engage in thrilling multiplayer encounters within the futuristic cityscape.

Join our [![Join Discord](https://img.shields.io/badge/Discord-7289DA?style=plastic&logo=discord&logoColor=white)](https://discord.gg/7EJQP7TS) community.

## How it started
![netwalker_API](https://github.com/toshydev/netRunner/assets/91165689/c7aa2c0f-5622-4819-a24e-255801b400cf)

![netwalker_wireframes](https://github.com/toshydev/netRunner/assets/91165689/cbec104c-7d1b-48d4-9f25-b37e960e40d4)

---

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-orange.svg)](https://sonarcloud.io/summary/new_code?id=netRunner_backend)
Expand Down

0 comments on commit a9d31fa

Please sign in to comment.