Universal Friend List

Everything ships under ElderWorldStudio/FriendList/. Sample servers live in .Server (hidden in Unity by default; still included for deployment).

1. Open ElderWorldStudio/FriendList/Scenes/Demo.unity.
2. Select Resources/FriendManagerSettings (or the assigned settings asset on the initializer).
3. Set Backend Type and Use Native Implementation to match your project.
4. For the ElderWorldStudio custom server: set backend to Custom, configure Use WebSocket, Server URL, and WebSocket URL (see defaults in FriendManagerSettings).
5. Enter Play Mode and verify list load, presence, requests, and invites.

Quick start video

Prerequisites

• At least one networking stack: Photon PUN 2 or Fusion, Mirror, Netcode for GameObjects, FishNet, or a custom auth/runtime for Custom.
• Project compiles cleanly before importing this asset.

Import

1. Import the package into your project.
2. Wait for script compilation to finish.
3. Open the demo scene and confirm references (FriendManager, UI, settings).

1) FriendManagerSettings (ScriptableObject)

Create via Assets → Create → ElderWorldStudio → Friend List → Friend Manager Settings. Defaults use ElderWorldStudio-style URLs; override for your deployment.

2) FriendManagerInitializer

3) FriendManager

Core runtime component: friends, requests, blocking, game-type hooks, and UnityEvents for UI. Pair with UI prefabs and your canvas.

• FriendListEditorWindow — centralized editor entry for friend-list tools.
• FriendListSetupWizard / FriendListQuickSetup — guided or fast scene wiring.
• FriendListUIGenerator / FriendListItemGenerator — generate UI hierarchy or items to match your canvas.
• FriendManagerSettingsInspector / FriendManagerInitializerInspector — improved inspectors for core assets.
• NetworkBackendValidator — validates backend configuration in the editor.

Open tools from the Unity menu where the package registers them (ElderWorldStudio / Friend List), or use the Friend List editor window if present in your menu layout.

FriendManager

Scripts/Managers/FriendManager.cs — implements IFriendManager; exposes UnityEvents for inspector wiring.

Serialized configuration

UnityEvents (inspector)

FriendManagerSettings

Scripts/Managers/FriendManagerSettings.cs — same fields as listed in Unity setup; shared across scenes via reference.

FriendManagerInitializer

Scripts/Managers/FriendManagerInitializer.cs — Initialize(), CreateNetworkSystem(), GetUserId() (see inspector fields above).

Game types

GameTypeManager, RoomBasedGameTypeHandler, OpenWorldGameTypeHandler, and example settings under Scripts/GameTypes/ tailor invitations and room joins to your game structure.

UI scripts

FriendListUI, FriendListItemUI, FriendRequestItemUI, FriendRequestsUI, AddFriendUI — bind to FriendManager and prefabs listed above.

Implemented per backend (native or custom). Common operations:

Node.js (folder: .Server/websocket)

• npm install
• npm start (or npm run dev for auto-reload)
• Unity REST: http://localhost:3001 · WS: ws://localhost:3001/ws?userId=<id>

PHP (folder: .Server/php)

• Configure config.php
• php -S localhost:3000 for local dev, or Apache/Nginx in production
• Unity: http://localhost:3000 with Use WebSocket disabled
• Send X-User-Id header on REST calls (see PHP README)

Base URL example: http://localhost:3001. Full list from package .Server/websocket/README.md:

Auth & friends

Friend requests

Blocked users

Rooms & invitations

Configuration (config.js)

Connect to ws://localhost:3001/ws?userId=<user_id> (adjust host/port for production).

Client → server

{ "type": "heartbeat" }
{ "type": "status_update", "data": { "status": "online" } }
{ "type": "room_update", "data": { "playerCount": 5 } }

Server → client

{ "type": "connected", "data": { "userId": "..." } }
{ "type": "friend_request", "data": { "fromUserId": "...", "fromUsername": "..." } }
{ "type": "friend_status", "data": { "userId": "...", "status": "online" } }
{ "type": "invitation", "data": { "id": "...", "fromUserId": "...", "roomInfo": {...} } }
{ "type": "room_update", "data": { "roomId": "...", "playerCount": 5 } }
{ "type": "heartbeat_ack" }

Include X-User-Id on requests. Endpoints from .Server/php/README.md:

Configuration (config.php)

• Unity Asset Store: use the top bar button — set href on #link-asset-store in this file to your listing URL when published.
• Official site: set href on #link-official-site to your documentation or company page.
• Included readmes: .Server/websocket/README.md and .Server/php/README.md for server-only details.