From db04d86e22b4ca49d3e8cc60670caba9f39987b0 Mon Sep 17 00:00:00 2001 From: spacemeowx2 Date: Wed, 10 Jan 2024 14:18:31 +0800 Subject: [PATCH] update README --- LICENSE.txt | 2 +- README.md | 15 ++++++++------- README_zh.md | 7 ++++--- docker/Makefile.openwrt | 2 +- 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/LICENSE.txt b/LICENSE.txt index 82446d6..d3e7387 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -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 diff --git a/README.md b/README.md index 8c4bc16..2278795 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. @@ -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` @@ -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: diff --git a/README_zh.md b/README_zh.md index b6c2188..cc1c1cf 100644 --- a/README_zh.md +++ b/README_zh.md @@ -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) @@ -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` 客户端 @@ -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 群组里找人匹配 @@ -70,7 +71,7 @@ https://discord.gg/zEMCu5n -2. 点击保存，这时候 Switch 会开始通过你的电脑上网。 +2. 点击保存，这时 Switch 会开始通过你的电脑上网。 3. 启动游戏，然后按 L+R+LStick 进入局域网联机模式。 diff --git a/docker/Makefile.openwrt b/docker/Makefile.openwrt index 0166913..7c224d7 100755 --- a/docker/Makefile.openwrt +++ b/docker/Makefile.openwrt @@ -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