Bump version to v1.0, update README and credits

This commit:

* updates version to v1.0,
* updates README.md to note that Q3VR is out of the beta,
* updates credits to include idSoftware/Q3A
* adds "credits" on main screen (reference that this port is based on
  ioquake3 and Quake3Quest)

Author: RippeR37

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -96,6 +96,6 @@ body:
     attributes:
       label: Game version / build
       description: Which version of the app are you using?
-      placeholder: e.g. beta, v1.0
+      placeholder: e.g. v1.0
     validations:
       required: true

README.md

@@ -1,9 +1,11 @@
-# Quake 3 VR
+# [Quake 3 VR](https://ripper37.github.io/q3vr)
 
 **Quake 3 VR** (a.k.a. `q3vr`) is a PCVR port of Quake 3 Arena game based on:
 
-* `ioquake3` - community maintained fork of idTech3 engine,
-* `Quake3Quest` - port of `ioquake3` to Quest 2/3 mobile headsets.
+* [ioquake3](https://github.com/ioquake/ioq3) - community maintained fork of
+  idTech3 engine,
+* [Quake3Quest](https://github.com/Team-Beef-Studios/ioq3quest) - port of
+  `ioquake3` to Quest 2/3 mobile headsets by **Team Beef**.
 
 It includes several bugfixes, improvements and QoL features built specifically
 for VR.
@@ -23,20 +25,16 @@ for VR.
   * zoom with reticle for railgun
   * comfort options like vignette, height adjustements, weapon lasers, etc.
 
-> [!CAUTION]
-> Please bear in mind that this port is currently in **beta** state, which
-> means that there may be some bugs and compatibility issues that will be fixed
-> over time.
-
 
 ## How to play
 
 To download and set up the game:
 
 * Go to [Releases](https://github.com/RippeR37/q3vr/releases) page and download
-  the most recent release and install (or extract) to directory of your choosing
+  the latest release and install (or extract, if selected portable version) to
+	directory of your choosing,
 * If you own full version of the game, place `pak0.pk3` file from original game
-  in the `baseq3/` subdirectory
+  in the `baseq3/` subdirectory.
 
 then any time you want to play simply:
 
@@ -47,17 +45,17 @@ then any time you want to play simply:
 > It's highly recommended to go through configuration options in `Setup` menu -
 > before jumping into the game - to set controls and settings to your liking.
 
+> [!NOTE]
+> The game has built-in update notifications. Whenever new version will be
+> released, you will be notified about it on game startup.
 
-## Feedback / bug reporting
 
-> [!IMPORTANT]
-> This project is currently in **beta**. Feedback from users is required to make
-> any further improvements and fix bugs. If you've spotted any problems or have
-> any improvement ideas, please open GitHub issue with details and/or reach out
-> on Discord.
+## Feedback / bug reporting
 
-For your convienience this repository comes with a pre-defined template for
-creating issues which should make the process easier.
+If you've spotted any problems or have any improvement ideas, please open GitHub
+issue with details and/or reach out on Discord. For your convienience this
+repository comes with a pre-defined template for creating issues which should
+make the process easier.
 
 Please remember to include any details that may help reproduce and analyze the
 problem such as logs, your computer configuration, etc.
@@ -72,8 +70,8 @@ your controlers.
 
 * `B` on left hand opens/closes menu or goes one level up (like `ESC`)
 * `B` on right hand resets position of Virtual Screen
-* `Trigger` on active hand - selects currently selected option (like `LMB`)
-* `Trigger` on inactive hand - makes this hand active
+* `Trigger` on active hand - cursor click
+* `Trigger` on inactive hand - makes this hand the active one
 
 ### Controls as spectator
 
@@ -92,10 +90,10 @@ made in the in-game `Setup` configuration menus.
 
 ### Changing bindings/setting custom actions
 
-If you wish to change bindings, you can try doing so from your
-VR runtime's input configuration screen (e.g. Steam VR input bindings) or
-manually set specific actions to given keys. To do so, you need to create
-`autoexec.cfg` file in the `baseq3/` subdirectory and set custom bindings with:
+If you wish to change bindings, you can do so from your VR runtime's input
+configuration screen (e.g. Steam VR input bindings) or manually set specific
+game actions to given keys. To do so, you need to create `autoexec.cfg` file in
+the `baseq3/` subdirectory and set custom bindings with:
 
 ```
 set vr_button_map_<key> "<action>"
@@ -124,7 +122,10 @@ These are the default mappings:
 | `B` | `"+movedown"` | Crouch |
 | `A` | `"+moveup"` | Jump |
 
-Please refer to [Quake 3 Quest website](https://quake3.quakevr.com/) for more
+Default controls for Valve Index:
+![Default controls for Valve Index](https://ripper37.github.io/q3vr/media/bindings.png)
+
+Please refer to [Q3VR website](https://ripper37.github.io/q3vr) for more
 details.
 
 
@@ -146,8 +147,6 @@ If you're having some problems consider:
 * Checking if there isn't a newer verions of `Q3VR` available which may already
   have a fix for your problem
   * You can also check older versions to see if it worked before
-* **[BETA]** During beta, the game will open a console in the background with
-  logs - they may contain something that will hint what's the problem
 
 If you're unable to find solution to your problem yourself, please reach out to
 the community (see section below) or
@@ -178,7 +177,9 @@ cmake -S . -B build
 cmake --build build --config Release
 ```
 
-Check out [GitHub Actions workflow](.github/workflows/build.yml) for reference.
+Check out [GitHub Actions workflow](.github/workflows/build.yml) for reference
+and [GitHub Actions](https://github.com/RippeR37/q3vr/actions) for recent
+builds.
 
 
 ## Contributions
@@ -198,3 +199,20 @@ on VR games, ports or tools you can do so via:
 
 Please also consider supporting authors of `ioquake3` and `Quake3Quest`
 projects.
+
+
+## Credits
+
+This port is based on work of:
+
+* id Software (creators of idTech3 and Quake 3 Arena)
+* ioquake3 team (creators and maintainers of [ioquake3 fork](https://github.com/ioquake/ioq3))
+* Team Beef (creators of [Quake3Quest port](https://github.com/Team-Beef-Studios/ioq3quest))
+
+I would also like to personally thank everyone who helped working specifically
+on this port with special thanks to:
+
+* Royd0
+* @ernie
+* XQuader
+* Dteyn

cmake/identity.cmake

@@ -1,5 +1,5 @@
 set(PROJECT_NAME q3vr)
-set(PROJECT_VERSION 0.9)
+set(PROJECT_VERSION 1.0)
 
 set(SERVER_NAME q3vr-ded)
 set(CLIENT_NAME q3vr)

cmake/platforms/windows.cmake

@@ -41,8 +41,7 @@ if(MSVC)
     list(APPEND CLIENT_LINK_OPTIONS "/MANIFEST:NO")
 endif()
 
-# Temporarily disable this to ensure logs are visible (for the beta)
-# set(CLIENT_EXECUTABLE_OPTIONS WIN32)
+set(CLIENT_EXECUTABLE_OPTIONS WIN32)
 
 # It's only necessary to set this on Windows; elsewhere
 # CMAKE_EXECUTABLE_SUFFIX will be empty anyway, or we want

code/q3_ui/ui_atoms.c

@@ -830,6 +830,11 @@ void UI_DrawString( int x, int y, const char* str, int style, vec4_t color )
 		charw =	SMALLCHAR_WIDTH;
 		charh =	SMALLCHAR_HEIGHT;
 	}
+	else if (style & UI_TINYFONT)
+	{
+		charw = SMALLCHAR_WIDTH / 2;
+		charh = SMALLCHAR_HEIGHT / 2;
+	}
 	else if (style & UI_GIANTFONT)
 	{
 		charw =	GIANTCHAR_WIDTH;

code/q3_ui/ui_credits.c

@@ -103,10 +103,15 @@ static void UI_CreditMenu_Draw_q3vr( void )
 	y += 2 * PROP_HEIGHT * PROP_SMALL_SIZE_SCALE;
 	UI_DrawString( 320, y, "by RippeR37", UI_CENTER|UI_BIGFONT, color_silver );
 
-	y = 300;
+	y = 320;
 	UI_DrawString( 320, y, "        based on ioquake3            based on Quake3Quest   ", UI_CENTER|UI_SMALLFONT, color_grey );
 	y += 1.42 * PROP_HEIGHT * PROP_SMALL_SIZE_SCALE;
 	UI_DrawString( 320, y, "      https://ioquake3.org        https://quake3.quakevr.com", UI_CENTER|UI_SMALLFONT, color_url );
+	
+	y = 400;
+	UI_DrawString( 320, y, "            port of Quake 3 Arena by id Software            ", UI_CENTER|UI_SMALLFONT, color_grey );
+	y += 1.42 * PROP_HEIGHT * PROP_SMALL_SIZE_SCALE;
+	UI_DrawString( 320, y, "                   https://idsoftware.com                   ", UI_CENTER|UI_SMALLFONT, color_url );
 }
 
 
@@ -194,35 +199,6 @@ Special Thanks to the whole discord!
 }
 
 
-/*
-=================
-UI_CreditMenu_Key
-=================
-*/
-static sfxHandle_t UI_CreditMenu_Key( int key ) {
-	if( key & K_CHAR_FLAG ) {
-		return 0;
-	}
-
-	qboolean skipIOQ3Credits = trap_Cvar_VariableValue("skip_ioq3_credits") == 1.0f;
-
-	s_credits.frame++;
-	if (s_credits.frame == 1) {
-		s_credits.menu.draw = UI_CreditMenu_Draw_q3vr;
-	} else if (s_credits.frame == 2 && !skipIOQ3Credits) {
-		s_credits.menu.draw = UI_CreditMenu_Draw_q3q;
-	} else if (s_credits.frame == 3 && !skipIOQ3Credits) {
-		//Only show these once the first time someone plays
-		trap_Cvar_SetValue("skip_ioq3_credits", 1.0f);
-		trap_Cmd_ExecuteText( EXEC_APPEND, "writeconfig " Q3CONFIG_CFG "/n");
-		s_credits.menu.draw = UI_CreditMenu_Draw_ioq3;
-	} else {
-		trap_Cmd_ExecuteText( EXEC_APPEND, "quit\n" );
-	}
-	return 0;
-}
-
-
 /*
 ===============
 UI_CreditMenu_Draw
@@ -283,6 +259,35 @@ static void UI_CreditMenu_Draw( void ) {
 }
 
 
+/*
+=================
+UI_CreditMenu_Key
+=================
+*/
+static sfxHandle_t UI_CreditMenu_Key( int key ) {
+	if( key & K_CHAR_FLAG ) {
+		return 0;
+	}
+
+	const qboolean skipCredits = trap_Cvar_VariableValue("skip_full_credits") == 1.0f;
+
+	s_credits.frame++;
+	if (s_credits.frame == 1 && !skipCredits) {
+		s_credits.menu.draw = UI_CreditMenu_Draw;
+	} else if (s_credits.frame == 2 && !skipCredits) {
+		s_credits.menu.draw = UI_CreditMenu_Draw_q3q;
+	} else if (s_credits.frame == 3 && !skipCredits) {
+		//Only show these once the first time someone plays
+		trap_Cvar_SetValue("skip_full_credits", 1.0f);
+		trap_Cmd_ExecuteText( EXEC_APPEND, "writeconfig " Q3CONFIG_CFG "/n");
+		s_credits.menu.draw = UI_CreditMenu_Draw_ioq3;
+	} else {
+		trap_Cmd_ExecuteText( EXEC_APPEND, "quit\n" );
+	}
+	return 0;
+}
+
+
 /*
 ===============
 UI_CreditMenu
@@ -291,7 +296,7 @@ UI_CreditMenu
 void UI_CreditMenu( void ) {
 	memset( &s_credits, 0 ,sizeof(s_credits) );
 
-	s_credits.menu.draw = UI_CreditMenu_Draw;
+	s_credits.menu.draw = UI_CreditMenu_Draw_q3vr;
 	s_credits.menu.key = UI_CreditMenu_Key;
 	s_credits.menu.fullscreen = qtrue;
 	UI_PushMenu ( &s_credits.menu );

code/q3_ui/ui_menu.c

@@ -246,16 +246,22 @@ static void Main_MenuDraw( void ) {
 		UI_DrawString( 320, yPos, "Quake III Arena(c) 1999-2000, Id Software, Inc.  All Rights Reserved", UI_CENTER|UI_SMALLFONT, color );
 	}
 
-	vec4_t color_grey = {0.3f, 0.3f, 0.3f, 1.0f};
+	vec4_t color_grey = {0.35f, 0.35f, 0.35f, 1.0f};
+	vec4_t color_dark_grey = {0.23f, 0.23f, 0.23f, 1.0f};
 
 	yPos += SMALLCHAR_HEIGHT + 12;
 	UI_DrawString( 320, yPos, "Quake 3 VR", UI_CENTER|UI_SMALLFONT, color_white );
 	yPos += SMALLCHAR_HEIGHT + 2;
 	UI_DrawString( 320, yPos, "by RippeR37", UI_CENTER|UI_SMALLFONT, color_grey );
 
+	yPos += 2;
+	UI_DrawString( 20, yPos, "based on ioquake3", UI_LEFT|UI_TINYFONT, color_dark_grey );
+	yPos += SMALLCHAR_HEIGHT / 2 + 1;
+	UI_DrawString( 20, yPos, "based on Quake3Quest", UI_LEFT|UI_TINYFONT, color_dark_grey );
+
 	// Version
-	vec4_t color_red = {0.65f, 0.0f, 0.0f, 1.0f};
-	UI_DrawString( 610, 455, "BETA", UI_CENTER|UI_SMALLFONT|UI_PULSE|UI_LEFT, color_red );
+	vec4_t color_dark_red = {0.65f, 0.0f, 0.0f, 1.0f};
+	UI_DrawString( 610, 455, "v1.0", UI_CENTER|UI_SMALLFONT|UI_PULSE|UI_LEFT, color_dark_red );
 }
 
 

code/qcommon/q_shared.h

@@ -327,6 +327,7 @@ typedef enum {
 #define UI_SMALLFONT	0x00000010
 #define UI_BIGFONT		0x00000020	// default
 #define UI_GIANTFONT	0x00000040
+#define UI_TINYFONT	0x00000080
 #define UI_DROPSHADOW	0x00000800
 #define UI_BLINK		0x00001000
 #define UI_INVERSE		0x00002000

code/vr/vr_cvars.c

@@ -51,7 +51,7 @@ cvar_t *q3vr_update_version_check = NULL;
 
 void VR_InitCvars( void )
 {
-	Cvar_Get ("skip_ioq3_credits", "0.0", CVAR_ARCHIVE);
+	Cvar_Get ("skip_full_credits", "0.0", CVAR_ARCHIVE);
 	vr_worldscale = Cvar_Get ("vr_worldscale", "32.0", CVAR_ARCHIVE);
 	vr_worldscaleScaler = Cvar_Get ("vr_worldscaleScaler", "1.0", CVAR_ARCHIVE);
 	vr_hudDepth = Cvar_Get ("vr_hudDepth", "15", CVAR_ARCHIVE);