jk2mv icon indicating copy to clipboard operation
jk2mv copied to clipboard

Documentation

Open ouned opened this issue 8 years ago • 11 comments

  • [x] reflists
  • [x] API
  • [x] clientside cvars
  • [x] external http downloads
  • [x] dynamic glow shaders
  • [x] MVAPI_LOCATE_GAME_DATA
  • [x] ui_menulevel
  • [x] ingame_setup_modoptions
  • [x] ent's recording options (all cmds and cvars are documented already)
  • [x] MVF_NOSPEC, MVF_SPECONLY
  • [ ] MVAPI_DISABLE_STRUCT_CONVERSION

ouned avatar Aug 17 '15 15:08 ouned

Undocumented clientside cvars:

  • [x] com_busyWait
  • [x] r_ext_texture_filter_anisotropic
  • [ ] s_sdl* cvars
  • [ ] New r_* cvars from SDL
  • [ ] New in_* cvars from SDL
  • [x] r_ext_multisample (OpenGL doesn't load when I set it, is it ready?)
  • [x] r_fontSharpness
  • [ ] New net_* cvars
  • [x] r_textureLODBias
  • [x] r_consoleFont
  • [x] con_height
  • [x] con_scale
  • [x] con_timestamps
  • [x] cl_autoDemo
  • [x] cl_autoDemoFormat
  • [x] cl_drawRecording
  • [ ] … more? Feel free to edit this post and add them.

Probably too ambitious for 1.2. I propose to keep the wiki page in alphabetical order.

aufau avatar May 18 '16 12:05 aufau

i wouldn't go for documenting all of them as some are pretty obvious anyway

ouned avatar May 18 '16 12:05 ouned

+1 for @aufau i think all new cvars need to be documented, not ingame, just in documentation (wiki, readme, etc...)

TriForceX avatar May 18 '16 13:05 TriForceX

Maybe their meaning is obvious, but their existence is not for someone who has been using jk2mp.exe previously. We don't stick consistently to mv_ prefix and it doesn't make it any easier.

aufau avatar May 18 '16 16:05 aufau

And client commands:

  • [x] saveDemo
  • [x] saveDemoLast
  • [x] minimize
  • [x] Alt+Enter bind

aufau avatar May 25 '16 13:05 aufau

I pushed CVARS.rst with full list/description of new and modified cvars. Left some undocumented (but listed!) as they are not really worth documenting. Please update it when you change something. I think client/server cvars should stay split in the wiki as they are now.

aufau avatar Jun 24 '16 18:06 aufau

what about avi recording? I think it should documented, too

ouned avatar Dec 03 '16 20:12 ouned

  • [x] avi recording
  • [x] VM profiler

aufau avatar Feb 16 '17 23:02 aufau

  • [x] API Level 2

ouned avatar Jun 06 '17 09:06 ouned

  • [x] API Level 3

aufau avatar Jan 20 '18 15:01 aufau

  • [ ] ent files

ouned avatar Nov 14 '18 22:11 ouned