Developer want to rework client and server modules/classes

[Ismoh]

This is the successor issue to #27, which is more or less done and would be to huge to continue.

• [x] Rename server_class to Server
• check for inheritance of current server.self implementation to avoid a Server 'object' in Server.lua and sock.lua
• clients store last received nuid to see check that nothing is out of sync -> does this make sense? Maybe check if there is already a globals set. Mhh. Check if there is a gap > 2 between latest stored nuid and next received and log a warning then.
• [x] NetworkVscUtils
• addNetworkVscs needs to be accessible by client AND server, but! if server then nuid ~= nil. if client then nuid can be nil, because client entities like projectiles needs to ask for a nuid on server
• [x] EntityUtils
• sync entities transform and velocity to clients when spawning
• sync transform afterwards
• sync health
• sync death

TBC

[Ismoh]

FYI: based on #27 branch

[Ismoh]

Use reliable, unsequnced and unreliable sendMode.

Reliable is default.

Reliable:

• entity spawn
• entity kill
• health
• world sync

Unreliable

• velocity
• position

Other stuff:

1. when client connects first time, ask for seed and check guid + change if there is any duplicate
2. when seed received, cache seed and restart game. Start with cached seed. Clear cached seed. Connect, with seed or code in connection data send to server.
3. When client connected the second time with seed in data, send mina, clientInfo, position and health
4. Server then sends his and all clients minas, position and health.
5. Server and clients start to continuos send position, health and 'needNuid' for clients
6. When server received 'needNuid' send 'newNuid' to all clients

Enough for now!

[Ismoh]

• Store messageIds per session with flag SENT or ACK: messageIds = { 1 = ACK, 2 =..., 10 = SENT }

• if messageIds > 128 start at 0 again

• When sending any message add messageId of sender to data. Can we use sock.sentPackages for the messageId?

• When receiving message, send ACK back to sender with messageId in data.

• When sender got ACK from receiver, update messageIds to ACK

• Store nuid per peer and resend if not ACKed. DO I NEED THIS?

• Resend message, if not acked after RTT*2

• if message received and already acked, ignore it.

• edit sock.lua to not create server or connect to server when server or client object is initialised?

[Ismoh]

Before doing any network stuff, extend logger with categories like GUID, NUID, ENTITY, NET, NOITA_COMPONENTS, etc. ✔️

Add log level per category in modSettings. ✔️

Log file be like: TL;DR

[Ismoh]

Change log of client server to use pprint.format to get a return instead of writing to io or console: https://github.com/jagt/pprint.lua#options ✔️

[Ismoh]

Remove all callbacks and rework them step by step, also schemas. ~When connecting dont send minä, sent seed and restart client, then auto connect and sent minä.~ No need for a restart anymore.

[Ismoh]

Use apto and exe filename for unique guid ✔️

[Ismoh]

Put networking update in one function and run this is WorldPreUpdate and OnPausePreUpdate. Does it make sense to run Networking update on pre normal and postUpdate?

[Ismoh]

Add saveSlot number into saveSlot cache. ✔️

[Ismoh]

When connecting the second time, clients save directory has to be empty, otherwise seed doesnt work: Try to remove the savefolders content with start /wait, because lfs isnt able to delete. I think because the directory is still in use. see below: https://stackoverflow.com/a/13258451/3493998 https://stackoverflow.com/a/9480476/3493998

Deprecated, because solved it without restarting. Thanks to Evaisa. ✔️

[Ismoh]

[Ismoh]

Fix unit test! 😡

[Ismoh]

For the future: Sync minäs arm leg and other stuff, but make it configurable, or better to say, when threshold is reached (lag ~60ms), then only sync necessary stuff like projectiles, enemies and position of minäs

[Ismoh]

Add version to playerInfo to detect version missmatch

[Ismoh]

Add exclude include for spawning entities. Player for example do need to be spawned, but a dump copy of it.

When server got needNuid, check if entity already was spawned (client guid + localEntityId).

I think I dont need messageIds, when entityIds + guid can be used.

Add reseting guid, when development build is used, otherwise guid will be the same. Do I want to add guid check for server/client? Yes...

[Ismoh]

When sock.lua creates a new client on server object, use NoitaMP client object, instead of sock.lua client object.

[Ismoh]

Override all send functions to set acknowledge. Copy&paste acknowledge of sock.lua#Client:send

[Ismoh]

I need to add a 'cache' list for detecting, if entities moved and needs to be synced: entities[entityId] = { health, pos, velo, etc } (round health, position, velo, etc otherwise this cache is obsolete) Then getFilteredEntities After that compare In addition: use callback function in getFilteredEntities to add additionalChecks like:

• nuid set?
• moved/changed?
• isRelatedToMinä (inventory)

If client disconnects clear list. (client only sends minä and projectiles) If entity died, remove from list.

Double check if entityId for nuid changed in GlobalsUtils, when set or removed from cache.

[Ismoh]

Only owner is allowed to send entityData?

[Ismoh]

Load entities once per world update and pass the list as parameter.?

[Ismoh]

• SendVelocity and Position when created
• SendVelocity only once? Does it change?
• SendPosition each x frames
• Change 'DoesAnythingChanged' to be more inaccurate (0.2 instead of 0.01) otherwise it will be too much for client.
• Split Velo and Position, because Position is the truth and velo is only for movement and prediction.
• send only position for minä (and maybe enemies)?

[Ismoh]

[Ismoh]

Added tick rate and changed detection of changes, but clients fps still drop to ~29-55. I need to profile again!

[Ismoh]

• GetEntitiesInRadius + cache
• isAlive if not remove from cache, then next
• hasNuidComp, then hasChanged. If not then check if networkEntity, if not next else add nvscs
• hasChanged and iAmOwner then send new pos+velo
• add to cache

[Ismoh]

Use coroutine as iterator for

• init network entities
• sending network messages on specific tick rate (ms)
• receive network messages on preUpdate
• send network messages on postUpdate

[Ismoh]

• Cache all modSettings by putting those into config.lua
• put "doesModSettingsChange" into PauseCallback funtion of init.lua, so that the check isnt done each update while playing.
• doesModSettingsChange only needs to check config.lua with modSettings
• rename all ModSettings to camelCase so that I am able to add better reading mapping:

config.lua:

modSettings {
radiusToDetectEntities.key = "noita-mp.radiusToDetectEntities",
radiusToDetectEntities.value = 250,
...
}

[Ismoh]

First check how long it takes to get a mod setting, by profiling ModSettingGet("foo.bar"):

local cpc = CustomProfiler.start("ModSettinGet")
local foo = ModSettingGet("bar.z")
CustomProfiler.stop("ModSettingGet", cpc)

[Ismoh]

First check how long it takes to get a mod setting, by profiling ModSettingGet("foo.bar"):

local cpc = CustomProfiler.start("ModSettinGet")
local foo = ModSettingGet("bar.z")
CustomProfiler.stop("ModSettingGet", cpc)

ModSettings execution is below 1ms! So this isn't the problem.

[Ismoh]

Use coroutine as iterator for

• init network entities
• sending network messages on specific tick rate (ms)
• receive network messages on preUpdate
• send network messages on postUpdate

Yield return iterator or index when execution time is greater equals 25ms (=40fps) Next frame continue on for loop

[Ismoh]

https://love2d.org/forums/viewtopic.php?t=79980

[Ismoh]

Profiler: Windows: https://stackoverflow.com/questions/6207573/how-to-append-output-to-the-end-of-a-text-file

Linux: https://stackoverflow.com/questions/17701989/how-do-i-append-text-to-a-file

[Ismoh]

Looks like I found the issue? I'll see, if this is the problem the next days: It has to be EntityUtils.syncEntityData.for!

If you are curious, have a look on frame 4559 in report.html: reports.zip

[Ismoh]

Clear caches, when entering and exiting holy mountain!

yes, use BiomeMapGetName( x:number = camera_x, y:number = camera_y ) -> name

name = $biome_holymountain

Better to use this one?

DebugBiomeMapGetFilename( x:number = camera_x, y:number = camera_y ) -> string

[Ismoh]

If client and server have a distance of 3*radius do not sync entities only sync world changes.

[Ismoh]

• [ ] Exclude minäs when syncing entities. Think of client is in servers entity sync radius, this client dont want to get servers position of his own copy on the server!

[Ismoh]

Receive network messages in preworldupdate and send messages in postworldupdate?

[Ismoh]

[Ismoh]

Note: If entity has children, loop children and add nuid + send it two clients

[ofoxsmith]

Shouldn't this branch be merged into develop? The goals of this PR have been completed, so why hasn't it been merged?

[ofoxsmith]

As far as I can tell, most of the issues and PRs based off of this branch are seperate issues - not related to the client/server module rework.

[Ismoh]

It isn't merged, because other branches are based on this. But yes, it's time for it

[ofoxsmith]

Should we merge it after #89 is finished?

[Ismoh]

Yes. If there is stuff, not fully or correct synced, we can and should create follow up issues