From 3f34c43f51f00591e874dca780b8a0b7df74ddd4 Mon Sep 17 00:00:00 2001 From: sprunk Date: Tue, 12 Sep 2023 00:28:58 +0200 Subject: [PATCH] Migrate the last changelogs from the ticket --- .../changelogs/changelog-105-1214.markdown | 88 +++++++++++ .../changelogs/changelog-105-861.markdown | 143 ++++++++++++++++++ 2 files changed, 231 insertions(+) create mode 100644 doc/site/changelogs/changelog-105-1214.markdown create mode 100644 doc/site/changelogs/changelog-105-861.markdown diff --git a/doc/site/changelogs/changelog-105-1214.markdown b/doc/site/changelogs/changelog-105-1214.markdown new file mode 100644 index 0000000000..f7a3e5ee20 --- /dev/null +++ b/doc/site/changelogs/changelog-105-1214.markdown @@ -0,0 +1,88 @@ +--- +layout: post +title: Release 105-1214 +parent: Changelogs +permalink: changelogs/changelog-105-1214 +author: sprunk +--- + +The changelog since release 105-966 **until release 105-1214**, which happened in October 2022. + +## Caveats +* there is now only one `UnitUnitCollision` event for each unit pair, and return values from UnitUnitCollision are now ignored! +* `vsync` springsettng now defaults to -1 +* ships now obey `upright = false` when pulled out of water (still always upright when floating). +* killed most of ARB shader fallbacks + +## Features and fixes + +### Unit collisions +* multi-threaded unit steering and collisions. +* there is now only one `UnitUnitCollision` event for each unit pair, and return values from UnitUnitCollision are now ignored! +* added modrule, `movement.groundUnitCollisionAvoidanceUpdateRate`, for controlling steering performance vs quality tradeoff load. Reduce to get better quality at the cost of perf. Default value is 3 for cycling through all units over 3 sim frames. +* added modrule, `movement.unitQuadPositionUpdateRate`. Similar perf tradeoff to the above, but affects collision accuracy (incl. with projectiles). In particular, if this value isn't 1 then sometimes beamlasers/lightning can visibly ghost through units. Defaults to 3. +* added modrule, `movement.maxCollisionPushMultiplier`, limits the speed (as a multiplier relative to their base speed) units can push each other at. Defaults to infinity/unlimited. + +### Particles +* add animated "flipbook" CEGs: `animParams = "numX, numY, animLength"`. Enabled for BitmapMuzzleFlame, HeatCloudProjectile, SimpleParticleSystem and GroundFlash. +* some semi-transparent objects can cast colored shadows +* fixed smoke-trails with a non-standard smoke period +* `/dumpatlas` for now only works with `proj` argument to dump projectiles atlases to disk + +### Units on slopes +* ships now obey `upright = false` when pulled out of water (still always upright when floating). +* added `upDirSmoothing` to unit def so units could update their upward vector smoother than by default +* floating mobiles can be built over seafloor slopes + +### Bugger off! +* add `Spring.SetFactoryBuggerOff(unitID, bool? active, number? distanceFromFactoryCenter, number? radius, number? relativeHeading, bool? spherical, bool? forced) → bool active`. Forced means it also asks push-resistant units to move. Everything is optional. +* add `Spring.GetFactoryBuggerOff(unitID) → active, distance, radius, relativeHeading, spherical, forced`, same units as above. +* add `Spring.BuggerOff(x, y = groundHeight, z, radius, teamID, spherical = true, forced = true, excludeUnitID = nil, excludeUnitDefIDArray = nil) → nil`, for standalone bugger-off in-world (like happens when units stand on a construction site). +* `/debugcolvol` now shows factory bugger off, in cyan. Standalone bugger off not shown. + +### Key press scan codes +* add `Spring.GetPressedScans() → {[scanCode] = true, [scanName] = true, ...}`, similar to `Spring.GetPressedKeys` but with scancodes +* add `Spring.GetKeyFromScanSymbol(scanSymbol) → string keyName` that receives a scancode and returns the user's correspondent key in the current keyboard layout +* add `wupget:KeyMapChanged() → nil` callin for when the user switches keyboard layouts, for example switching input method language. + +### Selection box +* add `Spring.SetBoxSelectionByEngine(bool) → nil`. If set to false, engine won't apply selection when you release the selection box. +* add `Spring.GetSelectionBox() → minX, maxY, maxX, minY` (sic) returning the screen coordinates of the selection box. Nil if not dragging a box. + +### Rendering internals +* lots of engine internals (in particular, fonts) use modern approaches to rendering. Expect speed-ups. +* applied more robust algorithm of culling shadow projection matrix. The net result is that shadows should not disappear any longer on small maps, at oblique camera angles, etc. +* allow skipping the use of Texture Memory Pool to save ~512 MB (by default) of statically allocated memory. Note this might be detrimental due to possible memory fragmentation. See `TextureMemPoolSize` springsettings +* removed most of the sanity checks from window positioning code (reverted back to 105.0 like code). Now the engine won't resist to resizing the window as the user/widget wants. There are still some rules in place, but they shouldn't be too restrictive. +* FontConfig should be more robust upon failure and don't crash that often on FC errors +* fix multiple camera issues. +* fix the hardware cursor on Linux/Wayland. +* fixed incorrect cubemap texture mapping + +### Rendering API +* add `DrawGroundDeferred` callin such that bound g-buffers could be updated from say game side decals renderer. +* projectiles transformation matrices are now available through LuaVBO + +Added the following `GL.` constants: +* `TEXTURE_{1,2,3}D` +* `TEXTURE_CUBE_MAP` +* `TEXTURE_2D_MULTISAMPLE` +* `COLOR_ATTACHMENT{0...15}{,_EXT}` +* `DEPTH_ATTACHMENT{,_EXT}` +* `STENCIL_ATTACHMENT{,_EXT}` + +### Miscellaneous +* add `Spring.GetSyncedGCInfo(bool forceCollectionBeforeReturning = false) → number usage in KiB`. Use from unsynced to query the status of synced memory occupation and force garbage collection +* introduced `RapidTagResolutionOrder` option to control priority of domains when resolving rapid tags in case multiple Rapid mirrors are used at the same time. +* `/dumprng` switch to tap out the state of synced RNG, works similar to `/dumpstate` +* skirmish AI interface: add FeatureDef_isAutoreclaimable +* fix the 1 second pause/freeze players experience when a player or spectator disconnects from the match. +* fix SaveLoad hang in case when AllyTeams > 2 and one or more teams died. +* fix SaveLoad memory leaks. + +## pr-downloader +* add options to override rapid and springfiles url. +* add option to download from Rapid without using `streamer.cgi`, but files directly. See https://github.com/beyond-all-reason/pr-downloader/pull/9 +* improve file IO performance by multithreading it (big performance boost on Windows) +* fix handling of unicode paths on Windows +* fix finding and loading of SSL certificates on multiple Linux distributions (on Windows also switches to system certificate storage) diff --git a/doc/site/changelogs/changelog-105-861.markdown b/doc/site/changelogs/changelog-105-861.markdown new file mode 100644 index 0000000000..0b99e0bc40 --- /dev/null +++ b/doc/site/changelogs/changelog-105-861.markdown @@ -0,0 +1,143 @@ +--- +layout: post +title: Release 105-861 +parent: Changelogs +permalink: changelogs/changelog-105-861 +author: sprunk +--- + +The changelog since the fork **until release 105-861**, which happened in February 2022. + +## Caveats +* `wupget:GameProgress` interval 10 → 5 seconds +* basecontent now provides the `treetype0` to `treetype15` features with a model and some customparams +* buildings can be placed inside other buildings' open yardmap gaps +* demos are saved with UTC clock filename (could break filename parsing etc) + +## Features and fixes + +### Icons as UI +* new springsetting `UnitIconsAsUI` and an ingame `/iconsAsUI` command (all below have a `/command` variant without the "Unit"). Set to 1 to make radar icons behave like UI elements instead of in-world objects (e.g. no obscuring by terrain, distance fog, blurring or reflection in the water etc. +* new springsetting `UnitIconScaleUI`. Size scaling for icons when drawn as UI. +* new springsetting `UnitIconsHideWithUI`. Whether icons get hidden via F5. +* new springsettings `UnitIconFadeStart` and `UnitIconFadeVanish`, for making icons fade smoothly + +### Grass +* `Spring.{Add,Get,Remove}Grass` now works even if grass rendering is disabled (also fixes desync) +* `Spring.AddGrass` now has a 3rd param, grass intensity (returned by `Get`; putting 0 equivalent to using `Remove`) + +### Recursion +Allow shallow recursion (up to 16 calls deep) for the following callouts/callins: +* `Spring.{Create,Destroy}{Unit,Feature}` +* `Spring.GiveOrder{,Array}ToUnit{,Array,Map}` + +Additionally: +* `Spring.SpawnExplosion` works inside `Projectile{Created,Destroyed}` + +### Texture Atlases +* add `gl.CreateTextureAtlas(number x, number y, number? allocType, string? atlasName) → string texName`. +`x` and `y` have to be between 256 and the value of the springsetting `MaxTextureAtlasSizeX` (Y respectively). +`allocType` defaults to 0 if not specified. `atlasName` is an optional name for the atlas. +* add `gl.FinalizeTextureAtlas(string id) → bool success`. +* add `gl.DeleteTextureAtlas(string id) → bool success`. +* add `gl.AddAtlasTexture(string id, string luaTex, string? subAtlasTexName)`. Adds texture `luaTexStr` to sub-atlas `subAtlasTextureName` (defaulting to same name as `luaTex` if not specified) of atlas `id`. The lua tex has to be a regular 2D RGBA/UNORM texture. DDS textures can also be put into the atlas. +* add `gl.GetAtlasTexture(string texName, string luaTex) → number s, p, t, q`. Query an atlas texture for the UV coordinates (minU, maxU, minV, maxV) of a texture saved earlier with `Spring.AddAtlasTexture`. + +### Particles +* CEGs from allied projectiles now visible in the fog +* add `/softParticles` toggle and `SoftParticles` springsetting to make particles (esp. groundflashes) clipping into the ground fade a bit instead of having a jagged edge +* add `Spring.SetNanoProjectileParams(r, v, a, randR, randV, randA) → nil`. All params are numbers, and default to 0 when not given. The first three are starting rotation in °, rotation speed in °/s, and rotation acceleration in °/s². The other three are the same but multiplied with a random (-1; +1) before being added to the former, rolled once per particle at the start of its lifetime. +* add `Spring.GetNanoProjectileParams() → r, v, a, randR, randV, randA`, returns the parameters as above. +* add `/drawOrderParticles` command which makes particles obey draw order, supplied in CEG definition under the `drawOrder` key +* add `rotParams` key to `CSimpleParticleSystem` and `CBitmapMuzzleFlame` CEGs, a vector of 3 floats: rotation speed °/s, rotation acceleration °/s², starting rotation in ° + +### Advanced GL4 (shaders, VAO, etc) +* add `gl.GetVAO` which returns an object with a bunch of methods. +* add `gl.GetVBO`. +* add `Spring.GetSelectedUnitsCount` to the shader container (use case: F2 pathmap replacement, can show a general slope map if 0 units selected) +* add `gl.{Unit,Feature}{,Shape}GL4` temporary functions +* added a ton of uniforms for shaders +* add LuaShaders::Set{Unit,Feature}BufferUniforms for GPU side per unit/feature "uniforms" (SSBO in fact) +* gl.Uniform/gl.UniformInt/etc don't require location as a first param, name is fine too. + +### Lua constants for rendering +* add `Platform.glHave{AMD,NVidia,Intel,GLSL,GL4}` bools +* remove `Platform.glSupport24bitDepthBuffer` and add `Platform.glSupportDepthBufferBitDepth` instead +* add the following constants to `GL`: `LINE_STRIP_ADJACENCY`, `LINES_ADJACENCY`, `TRIANGLE_STRIP_ADJACENCY`, `TRIANGLES_ADJACENCY`, `PATCHES` +* add the following constants to `GL`: `[UNSINGED_]BYTE`, `[UNSINGED_]SHORT`, `[UNSINGED_]INT[_VEC4]`, `FLOAT[_VEC4]`, `FLOAT_MAT4` +* add the following constants to `GL`: `ELEMENT_ARRAY_BUFFER`, `ARRAY_BUFFER`, `UNIFORM_BUFFER`, `SHADER_STORAGE_BUFFER` +* add the following constants to `GL`: `READ_ONLY`, `WRITE_ONLY`, `READ_WRITE` +* add a ton of image type specifiers (`RGBA32` etc) to `GL` +* add a ton of barrier bit constants to `GL` + +### Other rendering-adjacent stuff +* most CEGs and weapon visuals are tested for texture validity such that sprites with invalid textures are not displayed. No more need for 1x1 empty texture +* fix skybox stretching and seams (in case it's represented by a cubemap) +* smoother area-command circle, vertices 20 → 100 +* add `Spring.{Set,Get}{Unit,Feature}AlwaysUpdateMatrix` which makes the unit "always update matrix" +* add `/reloadTextures [lua, smf, s3o, ceg]` to reload textures, all groups if none specified. +* filling the nano wireframe works on the current model heights (meaning units with pieces hidden high above but moved downward work correctly) +* add `globalRenderingInfo.availableVideoModes ` +* add `gl.GetFixedState` that returns a bunch of various GL constants and tables, it does a lot depending on args. +* `DeprecatedGLWarnLevel` springsetting default value 2 → 0 (to reduce spam) +* add `gl.AlphaToCoverage(bool enable, bool? force) → nil`, defined only if `GLEW_ARB_multisample` is supported by the platform, and otherwise the func itself is nil; `force` makes it apply even if MSAA level is under 4 +* improve AMD gfx card detection (looks for more strings, eg. "radeon", and in more places) +* add `gl.ClipDistance(number clipID, bool enabled) → nil`, `clipID` is 1 or 2. +* change `TextureMemPoolSize` springsetting default value 256 → 512 MB +* expose `windSpeed` to `Spring.{Get,Set}WaterParams` +* new bumpwater params (defaults): waveOffsetFactor (0.0), waveLength (0.15), waveFoamDistortion (0.05), waveFoamIntensity (0.5), causticsResolution (75.0), causticsStrength (0.08) +* fix sky reflections on the ground (`skyReflectModTex`) + +### Missile smoke trails +* weapon defs: add bool `smokeTrailCastShadow`, number `smokePeriod` (default 8), number `smokeTime` (default 60), number `smokeSize` (default 7), and number `smokeColor` (default 0.7, single value for all three RGB channels tint) to things with smoke trails +* weapon defs: add bool `castShadow`, for the projectile itself + +### Camera tweaks +* add integer springsetting `SmoothTimeOffset`. This attempts to smooth out the TimeOffset parameter that is used to calculated the tweened draw frames. Default 0, old behaviour. Recommended value of 2, this attempts to keep the actualy timeoffset within 90% of the true time. Best with vsync on. +* add boolean springsetting `CamFrameTimeCorrection`. Default false is the current behaviour, use true to get better interpolation during high load. + +### Builders +* new yardmap options for "stacked" buildings +* add `Spring.{Set,Get}UnitBuildParams(unitID, "buildDistance"/"buildRange3D", value) → nil` about unit build range (number) and whether it's spherical (bool) +* add `Spring.GetUnitInBuildStance(unitID) → bool` +* add the `gadget:AllowUnitCaptureStep(capturerID, capturerTeamID, victimID, victimTeamID, progressDiff) → bool` callin +* fix seaplanes being unbuildable on water if they were set to float rather than submerge + +### Other additions to Lua API +* `math.random()` now correctly accepts arguments when parsing defs +* allow `nil` as the first arg to `Spring.SetCameraState` +* `Spring.SetWMIcon` new 2nd arg, bool `force`: ignores the 32x32 icon restriction on Windows +* allow empty argument for `Spring.GetKeyBindings` to return all keybindings +* add `Spring.GetUnitsInScreenRectangle` +* added `Spring.SetWindowGeometry` for easy window positioning. +* add `Spring.ForceTesselationUpdate(bool normalMesh = true, bool shadowMesh = false) → bool isROAM` for ROAM +* parameterless `Spring.GetUnitFlanking()` now has an 8th return value, collected flanking bonus mobility + +### Misc features +* selection keys: add an `IdMatches` filter to use the internal name +* the default pathfinder (set via 0 in modrules) is now multi-threaded. In release 861, the old single-threaded pathfinder is temporarily accessible by setting the modrule to 2, but this gets removed later on in release 1544 when MT issues are fixed. +* add `/setSpeed x` to set game speed directly, still obeys min/max +* add `/endGraph 2` to bring the player back to the menu (1 still quits) +* keybinds: same action with different arguments now differentiated +* added a Load Game button to the raw spring.exe menu +* command cache increased 1024 → 2048 +* native AI interface: add `Feature_getResurrectDef` and `Feature_getBuildingFacing` +* native AI interface: add `spherical` param to `Get{Friendly,Enemy,Neutral,}{Units,Features}{In,}` + +### Misc fixes +* fix CEGs from allied projectiles: now visible in the fog +* fix disk read failures (files that get read failure errors are retried multiple times before giving up) +* fix enabling globallos not revealing unseen terrain changes immediately +* fix height bounds calculation, it now reflects the actual heights rather than the historical min/max (for example if the highest point went 100 → 90 → 110 → 100, previously `Spring.GetGroundExtremes` would return 100 → 100 → 110 → 110) +* fix `Spring.SpawnExplosion` crashing on some valid data +* fixed aircraft using smoothmesh to update if terrain was modified pre-game +* multiple fixes to save/load +* fix spring-dedicated not correctly showing output on Windows when not redirected (spring-headless already worked correctly) +* fix a crash when trying to add enemy units to a control group (e.g. selected via /godmode) +* fix a desync caused by locale-dependent string sorting +* fix a crash trying to load a save done on a map with LuaGaia when currently playing on a map without it +* fix resources sometimes getting into the negative (on the order of 1e-15) due to float inaccuracies; in particular this caused units that cost 0 resources to shoot to be unable to fire due to insufficient resources +* fix "zombie torpedoes" bouncing under the map +* fix projectiles going through units sometimes +* fix the "unload dead unit" synced crash +* probably works on Linux Wayland (implementation doesn't support hardware cursor yet; added in a later release) \ No newline at end of file