Skip to content
This repository has been archived by the owner on Aug 24, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Aidunlin committed Jan 23, 2021
1 parent a455207 commit 84295ff
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# PaddleBattle
Paddle Battle: A multiplayer action game with pong-like mechanics (in early development)
# Paddle Battle
A multiplayer action game with pong-like mechanics (in early development).

Paddle Battle is a hobby project of mine. It's my first dive into game development, and I've been really enjoying it so far. I mostly just add/edit stuff that I want to add/edit. I do want the game to eventually have items/powerups, maps/gamemodes, online multiplayer, and some type of singleplayer experience, among other things.
Paddle Battle is a hobby project of mine. It's my first dive into game development, and I've been really enjoying it so far. I mostly just add/edit stuff that I want to add/edit. I do want the game to eventually have items/powerups, maps/gamemodes, and some type of singleplayer experience, among other things.

With that being said, I hope you find enjoyment in Paddle Battle. Any feedback, be it praise, suggestions, or criticisms, is greatly appreciated.

## How to play

Head over to the [releases page](https://github.com/Aidunlin/PaddleBattle/releases) and download the latest zip. Extract and run the exe (some releases have a .pck file, be sure to keep it in the same directory).

Press start, enter, or keypad enter on your input device to join the game. Two people can play on a full-size keyboard!
Press start, enter, or keypad enter on your input device to join the game. Up to 8 people can play at once!

Controls as of 0.3.0:
* Controller - Left stick to move, right stick to rotate, left trigger to sprint
* Keyboard (left side) - WASD to move, G and H to rotate, shift to sprint
* Keyboard (right side) - Arrow keys to move, keypad 2 and 3 to rotate, keypad 1 to sprint
Controls as of 0.4.0:
* Controller - Left stick to move, right stick to rotate, left trigger to dash
* Keyboard (left side) - WASD to move, G and H to rotate, shift to dash
* Keyboard (right side) - Arrow keys to move, keypad 2 and 3 to rotate, keypad 1 to dash (turn on Num Lock)

Note that controls, mechanics, and features will change and have changed across releases prior to 1.0. The full release will include customizable key binds, game options, and more.

Your objective is to bounce balls off of the enemy paddle's back side, causing them to lose health. How you do this is up to you. Whether you want to send a flurry of balls at your foes in the hopes that they'll be overwhelmed, or send a few calculated shots that precisely deflect around the map, one thing is for certain: you are a paddle. And this is Paddle Battle.
Your objective is to bounce balls off of the enemy paddle's back side, causing them to lose health. How you do this is up to you.

## Next update - 0.4.0 (ETA December 2020)
## How to play over LAN

0.4.0 will introduce online multiplayer via a unified experience, similar to how a game like Duck Game handles multiplayer. For example, you can have multiple people playing on a computer that is hosting a session with other computers.
0.4.0 introduces online multiplayer. By enabling the Open to LAN option and pressing play, you will act as the host. Others will connect to you by simply typing in your IP address and pressing join. This works without any additional setup over your network (including VPNs like Hamachi or Tunngle), but if you want to play with people who aren't in the same network, you have to port forward with the port used by Paddle Battle (8910).

Some multiplayer features like client-side prediction/interpolation and lag compensation might not be included in the 0.4.0 release, but instead in a 0.4.x patch.
Regardless of whether you are on the host machine or a client machine, you can have multiple people playing on your device as long as there is room available. For example, 2 people on the same computer can play with 3 people on a different computer. Each additional player on the same device will have the same in-game name followed by a number to differentiate between them. If you want to leave (if you are on a client) or end the game (if you are on the host), you can do so by pressing Escape.
2 changes: 1 addition & 1 deletion main/main.gd
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const CLIENT_PADDLE_SCENE: PackedScene = preload("res://paddle/clientpaddle.tscn
const BALL_SCENE: PackedScene = preload("res://ball/ball.tscn")
const CLIENT_BALL_SCENE: PackedScene = preload("res://ball/clientball.tscn")

const VERSION: String = "0.4.0.dev"
const VERSION: String = "0.4.0"
const MOVE_SPEED: int = 500

var is_playing: bool = false
Expand Down

0 comments on commit 84295ff

Please sign in to comment.