Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
spacemeowx2 committed Jan 10, 2024
1 parent 076475c commit db04d86
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 12 deletions.
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

switch-lan-play: Make you and your friends play games like in a LAN.
switch-lan-play: Enjoy playing games with your friends as if you were in a LAN.
Copyright (C) 2018 spacemeowx2

This program is free software: you can redistribute it and/or modify
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# switch-lan-play

[![Build status](https://github.com/spacemeowx2/switch-lan-play/workflows/Build/badge.svg)](https://github.com/spacemeowx2/switch-lan-play/actions?query=workflow%3ABuild)
[![Chat on discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/zEMCu5n)

English | [中文](README_zh.md)

Make you and your friends play games like in a LAN.
Enjoy playing games with your friends as if you were in a LAN.

```
Internet
Expand All @@ -21,7 +22,7 @@ Switch <--------> PC(lan-play) <-------------> Server

# Usage

To play with your friends, you and your friends should run lan-play client connecting to the **same** Server on your PC, and set static IP on your Switch.
To play with your friends, you and your friends should run the lan-play client, connecting to the **same** server on your PC, and set a static IP on your Switch.

Your PC and Switch **must** be connected to the same router.

Expand All @@ -42,7 +43,7 @@ Data sent to the relay server does not pass through the proxy.

## Ubuntu / Debian

This project depends on libpcap, you can install libpcap0.8-dev on Ubuntu or Debian:
This project depends on libpcap. You can install libpcap0.8-dev on Ubuntu or Debian:

`sudo apt install libpcap0.8-dev git gcc g++ cmake`

Expand Down Expand Up @@ -111,13 +112,13 @@ npm run build # build ts to js. run it again when code changed.
npm start
```

Use `--port` pass the port parameter, or else it will use `11451/udp` as default.
Use `--port` pass the port parameter, otherwise it will use `11451/udp` as default.

Use `--simpleAuth` pass the auth via username and password, or else there's no authentication.
Use `--simpleAuth` pass the auth via username and password, otherwise there's no authentication.

Use `--httpAuth` pass the auth via http url, or else there's no authentication.
Use `--httpAuth` pass the auth via http url, otherwise there's no authentication.

Use `--jsonAuth` pass the auth via json file, or else there's no authentication.
Use `--jsonAuth` pass the auth via json file, otherwise there's no authentication.

Example:

Expand Down
7 changes: 4 additions & 3 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# switch-lan-play

[![Build status](https://github.com/spacemeowx2/switch-lan-play/workflows/Build/badge.svg)](https://github.com/spacemeowx2/switch-lan-play/actions?query=workflow%3ABuild)
[![Chat on discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/zEMCu5n)

Expand Down Expand Up @@ -29,7 +30,7 @@ Switch <--------> PC(本工具) <-------------------> 服务器

1. 下载并安装最新的 [Npcap](https://nmap.org/npcap/#download)

2. 安装 Npcap 的时候记得选择 **Installed in WinPcap API-compatible mode** (以 WinPcap API 兼容模式安装)
2. 安装 Npcap 的时候记得选择 **Installed in WinPcap API-compatible mode** (以 WinPcap API 兼容模式安装)

3.[releases](https://github.com/spacemeowx2/switch-lan-play/releases) 下载最新版 `lan-play.exe` 客户端

Expand All @@ -41,7 +42,7 @@ Switch <--------> PC(本工具) <-------------------> 服务器
--relay-server-addr is required (必须输入 --relay-server-addr 参数)
Input the relay server address [ domain/ip:port ]: (输入中继服务器地址)
```
你可以从这个网站里提供的公共中继服务器列表中选择一个
你可以从这个网站提供的公共中继服务器列表中选择一个
https://www.lan-play.com/

也可以到本项目的 Discord 群组里找人匹配
Expand Down Expand Up @@ -70,7 +71,7 @@ https://discord.gg/zEMCu5n
</tbody>
</table>

2. 点击保存,这时候 Switch 会开始通过你的电脑上网。
2. 点击保存,这时 Switch 会开始通过你的电脑上网。

3. 启动游戏,然后按 L+R+LStick 进入局域网联机模式。

Expand Down
2 changes: 1 addition & 1 deletion docker/Makefile.openwrt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ define Package/$(PKG_NAME)
endef

define Package/$(PKG_NAME)/description
Make you and your friends play games like in a LAN.
Enjoy playing games with your friends as if you were in a LAN.
endef

define Build/Prepare
Expand Down

0 comments on commit db04d86

Please sign in to comment.