mirror of
https://github.com/nestriness/nestri.git
synced 2025-12-12 08:45:38 +02:00
Fixed Nuxt Documentation build + added installation steps (#120)
Co-authored-by: Diefferson Koderer Môro <diefferson.moro@gmail.com>
This commit is contained in:
committed by
GitHub
parent
390ee2ac0f
commit
cc51bd6f70
@@ -3,6 +3,44 @@
|
|||||||
::alert{type="danger"}
|
::alert{type="danger"}
|
||||||
Nestri is in a **very early-beta phase**, so errors and bugs may occur.
|
Nestri is in a **very early-beta phase**, so errors and bugs may occur.
|
||||||
::
|
::
|
||||||
|
|
||||||
|
|
||||||
|
## Step 1: Navigate to Your Game Directory
|
||||||
|
First, change your directory to the location of your `.exe` file. For Steam games, this typically means:
|
||||||
|
```bash
|
||||||
|
cd $HOME/.steam/steam/steamapps
|
||||||
|
ls -la .
|
||||||
|
```
|
||||||
|
### Step 2: Generate a Session ID
|
||||||
|
Create a unique session ID using the following command:
|
||||||
|
```bash
|
||||||
|
echo "$(head /dev/urandom | LC_ALL=C tr -dc 'a-zA-Z0-9' | head -c 16)"
|
||||||
|
```
|
||||||
|
This command generates a random 16-character string. Be sure to note this string carefully, as you'll need it for the next step.
|
||||||
|
### Step 3: Launch the Nestri Server
|
||||||
|
With your SESSION_ID ready, insert it into the command below, replacing `<paste here>` with your actual session ID. Then, run the command to start the Nestri server:
|
||||||
|
```
|
||||||
|
docker run --gpus all --device=/dev/dri --name nestri -it --entrypoint /bin/bash -e SESSION_ID=<paste here> -v "$(pwd)":/game -p 8080:8080/udp --cap-add=SYS_NICE --cap-add=SYS_ADMIN ghcr.io/nestriness/nestri/server:nightly
|
||||||
|
```
|
||||||
|
> \[!TIP]
|
||||||
|
>
|
||||||
|
> Ensure UDP port 8080 is accessible from the internet. Use `ufw allow 8080/udp` or adjust your cloud provider's security group settings accordingly.
|
||||||
|
### Step 4: Configure the Game within the Container
|
||||||
|
After executing the previous command, you'll be in a new shell within the container (example: `nestri@3f199ee68c01:~$`). Perform the following checks:
|
||||||
|
1. Verify the game is mounted by executing `ls -la /game`. If not, exit and ensure you've correctly mounted the game directory as a volume.
|
||||||
|
2. Then, start the Nestri server by running `/etc/startup.sh > /dev/null &`.
|
||||||
|
### Step 5: Running Your Game
|
||||||
|
Wait for the `.X11-unix` directory to appear in `/tmp` (check with `ls -la /tmp`). Once it appears, you're ready to launch your game.
|
||||||
|
- With Proton-GE: `nestri-proton -pr <game>.exe`
|
||||||
|
- With Wine: `nestri-proton -wr <game>.exe`
|
||||||
|
### Step 6: Begin Playing
|
||||||
|
Finally, construct the play URL with your session ID:
|
||||||
|
```
|
||||||
|
echo "https://nestri.io/play/$SESSION_ID"
|
||||||
|
```
|
||||||
|
Navigate to this URL in your browser, click on the page to capture your mouse pointer, and start playing!
|
||||||
|
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Nestri Node is easy to install using the provided installation script. Follow the steps below to get started.
|
Nestri Node is easy to install using the provided installation script. Follow the steps below to get started.
|
||||||
|
|
||||||
|
|||||||
@@ -1,39 +1,14 @@
|
|||||||
import { createResolver, logger, defineNuxtModule } from '@nuxt/kit'
|
|
||||||
import { $fetch } from 'ofetch'
|
|
||||||
import { version } from './package.json'
|
|
||||||
|
|
||||||
const { resolve } = createResolver(import.meta.url)
|
|
||||||
|
|
||||||
// That allows to overwrite these dependencies paths via `.env` for local development
|
|
||||||
const envModules = {
|
|
||||||
tokens: process?.env?.THEME_DEV_TOKENS_PATH || '@nuxt-themes/tokens',
|
|
||||||
elements: process?.env?.THEME_DEV_ELEMENTS_PATH || '@nuxt-themes/elements',
|
|
||||||
studio: process?.env?.THEME_DEV_STUDIO_PATH || '@nuxthq/studio',
|
|
||||||
typography: process?.env?.THEME_DEV_TYPOGRAPHY_PATH || '@nuxt-themes/typography'
|
|
||||||
}
|
|
||||||
|
|
||||||
const updateModule = defineNuxtModule({
|
|
||||||
meta: {
|
|
||||||
name: '@nuxt-themes/docus'
|
|
||||||
},
|
|
||||||
setup (_, nuxt) {
|
|
||||||
if (nuxt.options.dev) {
|
|
||||||
$fetch('https://registry.npmjs.org/@nuxt-themes/docus/latest').then((release) => {
|
|
||||||
if (release.version > version) {
|
|
||||||
logger.info(`A new version of Docus (v${release.version}) is available: https://github.com/nuxt-themes/docus/releases/latest`)
|
|
||||||
}
|
|
||||||
}).catch(() => {})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
// https://github.com/nuxt-themes/docus
|
// https://github.com/nuxt-themes/docus
|
||||||
extends: ['@nuxt-themes/docus'],
|
extends: ['@nuxt-themes/docus'],
|
||||||
|
|
||||||
devtools: { enabled: true },
|
devtools: { enabled: true },
|
||||||
|
|
||||||
|
modules: [
|
||||||
|
// Remove it if you don't use Plausible analytics
|
||||||
|
// https://github.com/nuxt-modules/plausible
|
||||||
|
'@nuxtjs/plausible'
|
||||||
|
],
|
||||||
|
|
||||||
|
compatibilityDate: '2024-09-29'
|
||||||
compatibilityDate: '2024-09-26'
|
|
||||||
})
|
})
|
||||||
31209
package-lock.json
generated
Normal file
31209
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user