# Setup guide

URL: https://www.papamo.dev/docs/setup

Set up a CS 1.6 server plugin, managed client and platform integration.

## Choose your role [#choose-your-role]

**Server owners** compile an AMXX plugin using the public includes. **Platform developers** additionally need an approved Papamo helper/session integration. Installing an include alone does not install the native renderer on players' computers.

The new cards and customizable scoreboard are implemented in source. A coordinated signed client release and in-game validation are still pending. Follow this guide with an approved compatible test bundle; the currently installed production helper may not yet support it. See [compatibility](/docs/papamovgui2/compatibility).

## Players: install the web helper or desktop app [#players-install-the-web-helper-or-desktop-app]

Players can use either option. They do **not** need to install the full desktop app when using the **web helper**.

| Option | Download | How players join |
| --- | --- | --- |
| Web helper · Windows x64 | [Download web helper](https://github.com/keenplify/16competitive-client/releases/latest/download/competitive16-web-helper.exe) | Use the browser interface and its managed partner-server launch flow |
| Web helper · Linux x64 | [Download web helper](https://github.com/keenplify/16competitive-client/releases/latest/download/competitive16-web-helper-linux) | Use the browser's Linux helper setup instructions, then launch the managed partner server |
| Web helper · Linux ARM64 | [Download web helper](https://github.com/keenplify/16competitive-client/releases/latest/download/competitive16-web-helper-linux-arm64) | Requires a supported game/runtime setup; helper availability alone does not establish native CS 1.6 HUD compatibility on ARM64 |
| Full desktop app · Windows | [Download app](/16competitive/download/windows) | Select the game installation and launch the partner server from the app |
| Full desktop app · Linux | [Download app](/16competitive#linux-downloads) | Choose your architecture, select the game installation and launch from the app |

**The web helper is the browser companion, not a standalone cosmetic-helper download.** During an authorized managed setup/launch it obtains and verifies the approved native bundle and installs/configures its cosmetic/HUD module for a supported CS 1.6 installation. Players should not manually copy a cosmetic DLL/module or run a separate cosmetic installer. Verified existing files may be reused.

### Web-helper setup [#web-helper-setup]

1. Open the [web app](https://16competitive.papamo.dev/web) or your supported partner launch page and sign in.
2. On Windows, download and open the web helper once to install/register the browser URL handler. On Linux, use the setup instructions generated by the web app for your architecture. Setup is per-user and does not require administrator rights.
3. Return to the browser and run its helper check. Allow the browser to open the installed helper when prompted.
4. Select your existing CS 1.6 installation in the helper-backed browser settings. Enable **in-game enhancements**, and enable **kill cards** for kill sprees.
5. Join through the managed partner-server launch action. The web helper prepares the verified native module and any required signed background runtime/assets for that flow, then launches the installed game under its assigned session.

The full desktop launcher UI is optional in this flow. The web helper remains a local installed program and may download a signed background runtime; it is not browser-only gameplay. The native game and its supported installation are still required. Installing the web helper does not install Counter-Strike itself.

Opening CS directly and manually connecting does not create an authorized managed HUD session. Likewise, playing a browser-rendered game without the local native CS/helper session does not provide PAPAMOVGUI2.

### Release compatibility still applies [#release-compatibility-still-applies]

Automatic native-module installation uses the approved packaged release. It does not make unreleased PAPAMOVGUI2 features available in an older bundle. Cards need `papamovgui2_v1`; customizable native tables additionally need `papamovgui2_scoreboard_v1`, with the matching host bridge where required. Do not bypass signature, hash or installation-compatibility checks to force support.

## 1. Prepare a test server [#1-prepare-a-test-server]

Use CS 1.6 with AMX Mod X and the Fakemeta module enabled. Start on a separate test instance and retain your normal plugin package for rollback. Use the AMXX compiler matching your server version.

Download the interfaces you need into `cstrike/addons/amxmodx/scripting/include/`:

- [papamovgui2.inc](/downloads/papamovgui2.inc) for animated cards.
- [papamovgui2_scoreboard.inc](/downloads/papamovgui2_scoreboard.inc) for a server-owned native scoreboard.
- [papamo_cosmetics.inc](/downloads/papamo_cosmetics.inc) for recipes already authorized and staged by the managed asset pipeline.

These are Pawn include files containing stocks. No new AMXX binary module is required beyond their existing Fakemeta dependency. Include only the interfaces your plugin uses, and initialize each once in `plugin_init`.

## 2. Compile and install a plugin [#2-compile-and-install-a-plugin]

For cards, copy the [AMXX quickstart](/docs/papamovgui2/quickstart) into a `.sma` file. For scoreboards, download [native_scoreboard.sma](/downloads/native_scoreboard.sma) into the server's `scripting/` directory.

From that directory, compile the scoreboard example on Linux:

```sh
./amxxpc native_scoreboard.sma -iinclude -ocompiled/native_scoreboard.amxx
```

On Windows:

```powershell
.\amxxpc.exe native_scoreboard.sma -iinclude -ocompiled/native_scoreboard.amxx
```

Create `compiled/` first if your compiler package does not provide it. Copy the compiled `.amxx` file to `cstrike/addons/amxmodx/plugins/`, then add its filename on a separate line in `cstrike/addons/amxmodx/configs/plugins.ini`:

```text
native_scoreboard.amxx
```

Restart the test server or change map. Check `amxx plugins` and `amxx modules` in the server console. Resolve compile errors, missing modules or plugin load errors before testing the client. Use one plugin as the owner of each viewer's card/scoreboard component.

## 3. Connect a compatible managed client [#3-connect-a-compatible-managed-client]

Launch the approved CS 1.6 installation through the managed partner-server connection flow. Enable in-game enhancements. Enable kill cards if testing cards; the native scoreboard works independently of the kill-card setting.

The helper must authorize this exact server endpoint under a live session. Connecting an ordinary client directly does not establish that authorization. Do not create session marker files manually or replace verified native binaries.

Allow up to two seconds for the capability handshake. The card preview responds to `/cards`; the scoreboard example refreshes once per second and appears while Tab is held. Stock clients keep their ordinary scoreboard. A handshake means display capability, not trusted identity or proof that a frame was painted.

## 4. Customize and connect real data [#4-customize-and-connect-real-data]

Change the example's column labels, widths, colors, title, team scores and values through the [scoreboard interface](/docs/papamovgui2/scoreboard). Translate server-supplied text for your players. Feed it confirmed server data; retain ownership, rankings and match results on your authoritative backend.

Build a full snapshot for each viewer and commit it. Filter private values on the server before dispatch. Send changes and renew snapshots before their TTL expires; a one-second refresh with a three-second TTL is a reasonable starting point for the example. Animation runs locally and needs no per-frame server updates.

For cosmetics, complete the [verified V/P/W asset pipeline](/docs/cosmetics/runtime-viewmodels) first. A model path or skin ID is not a valid recipe ID.

## Platform integration checklist [#platform-integration-checklist]

Public `.inc` files provide the server presentation interface. They do not provide a self-service helper redistribution SDK, partner entitlement API or signing service. Arrange approved platform access with Papamo before distributing native components.

Your integration must provide:

1. A compatible signed native module and host bridge, verified against the approved manifest and registry.
2. An owned managed session with a fresh ticket, live launcher lease and assigned server endpoint.
3. Explicit enhancement preferences and the managed partner-HUD authorization path.
4. Verified immutable assets and bounded local catalogs before selecting cosmetic recipes.
5. Session shutdown that revokes temporary ownership, credentials and workers. Current Windows/NextClient CS 1.6 installations retain their managed module; routine shutdown does not restore DLLs.

Keep the helper, launcher, host bridge and server contracts versioned together. The authenticated 1.6 Competitive match scoreboard remains separate from partner customization.

## Troubleshooting [#troubleshooting]

| Symptom | Check |
| --- | --- |
| Include not found | Compiler `include/` directory and `-iinclude` argument |
| Plugin fails to load | Matching AMXX compiler/server version and enabled Fakemeta |
| Availability remains false | Compatible bundle, managed partner flow, endpoint, live lease and enhancement setting |
| Cards absent | Kill-card preference, snapshot count/TTL and current component owner |
| Stock scoreboard still appears | Separate board capability, complete transaction, at least one contiguous column and valid TTL |
| Old board disappears | Renew before TTL; finish transactions within two seconds; inspect rejected fields |
| Cosmetic selection ignored | Approved staged recipe, source weapon mapping and 750ms selection expiry |

To disable the example, remove its plugin entry and restart/change map. Expired board snapshots fall back to stock presentation. Keep existing asset verification and session gates enabled throughout testing.

## Read with an LLM [#read-with-an-llm]

Use the [documentation index](/llms.txt) to find pages or [all documentation as text](/llms-full.txt) for one complete input. Each page has **Copy Markdown** and view controls. For this guide, use [/docs/setup.md](/docs/setup.md). These exports follow the [official Fumadocs LLM integration](https://www.fumadocs.dev/docs/integrations/llms).
