https://github.com/nathanpotter17/golfwithfriends
A multiplayer golf game using ThreeJS & Web Sockets.
https://github.com/nathanpotter17/golfwithfriends
Last synced: 4 months ago
JSON representation
A multiplayer golf game using ThreeJS & Web Sockets.
- Host: GitHub
- URL: https://github.com/nathanpotter17/golfwithfriends
- Owner: nathanpotter17
- Created: 2025-01-10T01:12:01.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-10T02:16:23.000Z (5 months ago)
- Last Synced: 2025-01-10T03:19:18.656Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GolfWithFriends
Welcome to **GolfWithFriends** – the most exciting way to bond with your buddies, one swing at a time! 🏌️♂️🏌️♀️ Whether you're aiming for a hole-in-one or just enjoying the chaos of multiplayer mayhem, this game is all about having fun.
## Features
- **Multiplayer Madness**: Play with your friends in real-time thanks to our WebSocket-powered server.
- **Easy Setup**: Launch the game with just two commands.
- **Endless Fun**: Whether you're a pro golfer or a first-timer, there's something here for everyone.
## Getting Started
### Prerequisites
Make sure you have:
- Node.js installed on your machine.
- Two terminals ready to go – one for the server and one for the client.
### Installation
1. Clone this repository:
```bash
git clone https://github.com/your-username/GolfWithFriends.git
cd GolfWithFriends
```
2. Install dependencies:
```bash
npm install
```
### Running the Game
1. Start the server:
```bash
npm run server
```
2. Start the client:
```bash
npm run dev
```
3. Your browser should open automatically. If it doesn’t, navigate to:
```
http://localhost:5173
```
4. Play locally by keeping two tabs open!
## How to Play
- Use your mouse and keyboard to control your shots. Use 1,2,3 to select clubs, and use the up and down arrow keys to adjust your shots vertical angle. Hold down spacebar to set the power of your shot, and release to take the shot.
- Compete with your friends to see who’s the ultimate golfer.
- Avoid obstacles, aim for the hole, and don’t forget to celebrate when you win! 🎉
## Contributing
We’re always looking for ways to make GolfWithFriends better! Feel free to:
- Report bugs
- Suggest new features
- Submit pull requests
## Coming Soon
- Matchmaking for online play via live links
- More courses and obstacles to challenge your skills
- Clubs, balls, and other customizations to make your golfer unique
- Map editor & submission system for user-generated content
## License
This project is licensed under the MIT License. See the `LICENSE` file for details.
---
**What are you waiting for? Grab your friends, launch the game, and let’s tee off!**