mirror of
https://github.com/mapbase-source/mapbase-game-src.git
synced 2024-12-26 07:55:28 +03:00
Added READMEs
This commit is contained in:
parent
805bb69ae0
commit
cb0577b679
37
.github/CONTRIBUTING.md
vendored
Normal file
37
.github/CONTRIBUTING.md
vendored
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
This file details how to contribute to Mapbase's game sources.
|
||||||
|
|
||||||
|
If you wish to contribute to Mapbase in some other way, see Mapbase's original Source 2013 repo:
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
This repository accepts pull requests for new scripts/files or changes to existing scripts/files.
|
||||||
|
|
||||||
|
All changes will be reflected in future updates and will be used in mods and maps using Mapbase. As a result, this repo
|
||||||
|
holds itself to a similar standard as that of the code repository.
|
||||||
|
|
||||||
|
All contributions must follow the following rules:
|
||||||
|
|
||||||
|
* A contribution must be aligned with Mapbase's goals and priorities and should not be "subjective"
|
||||||
|
or related to a specific mod or type of mod. For example, fixing an existing issue or adding a
|
||||||
|
new tool for mappers to use is usually fine, but adding a new custom weapon with its own assets
|
||||||
|
is usually not fit for Mapbase.
|
||||||
|
|
||||||
|
* All content in a contribution must be either already legally open-source or done with the
|
||||||
|
full permission of the content's original creator(s).
|
||||||
|
|
||||||
|
* Contributions must not break existing maps/content or interfere with them in a negative or non-objective way.
|
||||||
|
|
||||||
|
Contributions which do not follow these guidelines cannot be accepted into Mapbase.
|
||||||
|
|
||||||
|
Attempting to contribute content which seriously violates the rules above can lead to being blocked from contributing,
|
||||||
|
especially if done repeatedly.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
If your contribution is accepted, you may be listed in Mapbase's credits and the README's external content list:
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013/wiki/Mapbase-Credits#Contributors
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013/blob/master/README
|
||||||
|
|
||||||
|
You may also receive the "Contributor" or "Major Contributor" role on Mapbase's Discord server if you are
|
||||||
|
a member of it.
|
163
MAPBASE_CONTENT_USAGE.txt
Normal file
163
MAPBASE_CONTENT_USAGE.txt
Normal file
@ -0,0 +1,163 @@
|
|||||||
|
==============================================================
|
||||||
|
Mapbase Content Usage
|
||||||
|
Updated as of v7.0
|
||||||
|
==============================================================
|
||||||
|
|
||||||
|
Mapbase is an open-source project and its contents can be distributed and used at the discretion of its users. However, this project represents many parts of the Source modding community packaged into a whole, so credit is taken very seriously.
|
||||||
|
|
||||||
|
Up-to-date information about Mapbase content usage and credit are addressed in this article on Mapbase's wiki:
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013/wiki/Using-Mapbase-Content
|
||||||
|
|
||||||
|
==============================================================
|
||||||
|
|
||||||
|
>>>>>>>> EXTERNAL CONTENT USED IN MAPBASE <<<<<<<<
|
||||||
|
|
||||||
|
The Mapbase project is a combination of original code from its creators, code contributed by other Source modders, and code borrowed from open-source articles
|
||||||
|
and repositories (especially ones which are specifically published as free source code). One of Mapbase's goals is to make the most popular fixes and the most obscure
|
||||||
|
or complicated code changes accessible and easy to use for level designers and other kinds of Source modders who would otherwise have no idea how to implement them.
|
||||||
|
|
||||||
|
*** DISCLAIMER: Mapbase has a strict no-leak-content policy and only allows content created directly by contributors or content originating from open-source repositories.
|
||||||
|
If you believe any content in Mapbase originates from any leak or unauthorized source (Valve or otherwise), please contact Blixibon immediately.
|
||||||
|
Mapbase is intended to be usable by everyone, including licensed Source projects and Steam mods. ***
|
||||||
|
|
||||||
|
Mapbase uses content from the following non-Source SDK 2013 Valve games or SDKs:
|
||||||
|
|
||||||
|
-- Alien Swarm SDK (Used to backport features and code from newer branches of Source into a Source 2013/Half-Life 2 environment)
|
||||||
|
-- Source SDK 2007 Code (Used to implement some of Tony Sergi's code changes)
|
||||||
|
|
||||||
|
-- Alien Swarm (Used to port assets from the aforementioned SDK code features, e.g. game instructor icons)
|
||||||
|
-- Left 4 Dead (Used to port certain animations as well as assets from the aforementioned SDK code features, e.g. particle rain)
|
||||||
|
-- Half-Life: Source (Used to port friction tool textures)
|
||||||
|
|
||||||
|
Valve allows assets from these titles to be distributed for modding purposes. Note that ported assets are only used in the release build, not the code repository.
|
||||||
|
|
||||||
|
Mapbase may also contain new third-party software distributed under specific licensing. Please see the bottom of thirdpartylegalnotices.txt for more information.
|
||||||
|
|
||||||
|
Here's a list of Mapbase's other external code sources:
|
||||||
|
|
||||||
|
- https://github.com/95Navigator/insolence-2013 (Initial custom shader code and projected texture improvements; also used to implement ASW SDK particle precipitation code)
|
||||||
|
-- https://github.com/Biohazard90/g-string_2013 (Custom shadow filters, included indirectly via Insolence repo)
|
||||||
|
-- https://github.com/KyleGospo/City-17-Episode-One-Source (Brush phong and projected texture changes, included indirectly via Insolence repo)
|
||||||
|
- https://github.com/DownFall-Team/DownFall (Multiple skybox code and fix for ent_fire delay not using floats; Also used as a guide to port certain Alien Swarm SDK changes to Source 2013,
|
||||||
|
including radial fog, rope code, and treesway)
|
||||||
|
- https://github.com/momentum-mod/game (Used as a guide to port postprocess_controller and env_dof_controller to Source 2013 from the Alien Swarm SDK)
|
||||||
|
- https://github.com/DeathByNukes/source-sdk-2013 (VBSP manifest fixes)
|
||||||
|
- https://github.com/entropy-zero/source-sdk-2013 (skill_changed game event)
|
||||||
|
- https://github.com/Nbc66/source-sdk-2013-ce/tree/v142 (Base for VS2019 toolset support)
|
||||||
|
|
||||||
|
//---------------------------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
Valve Developer Community (VDC) sources:
|
||||||
|
|
||||||
|
- https://developer.valvesoftware.com/wiki/Dynamic_RTT_shadow_angles_in_Source_2007 (Dynamic RTT shadow angles by Saul Rennison)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Parallax_Corrected_Cubemaps (Parallax corrected cubemaps implementation from Brian Charles)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Adding_the_Game_Instructor (ASW SDK game instructor adapted to Source 2013 by Kolesias123; was implemented based on a translated article)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Brush_ladders (Functional func_ladders in Source 2013)
|
||||||
|
- https://developer.valvesoftware.com/wiki/CAreaPortalOneWay (func_areaportal_oneway)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Implementing_Discord_RPC (Discord RPC implementation; Mapbase has its own framework originally based on this article)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Rain_splashes (NOTE: This code is not completely used in Mapbase, but may still exist in its codebase)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Hand_Viewmodels (NOTE: This code is not completely supported by default because Mapbase does not yet have weapon viewmodels which support
|
||||||
|
interchangeable arms; this may change in the future)
|
||||||
|
|
||||||
|
- https://developer.valvesoftware.com/wiki/General_SDK_Snippets_%26_Fixes (Various snippets on the article, including the dropship gun fix)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Memory_Leak_Fixes (Most of these snippets were applied in later SDK updates, but some were not and have been added to Mapbase)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Env_projectedtexture/fixes (Misc. env_projectedtexture fixes; Some of these are superceded by Alien Swarm-based changes and not used)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Scenes.image (Original raw VCD file support; Code was improved for Mapbase and the article was later updated with it)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Extending_Prop_Sphere (prop_sphere customization)
|
||||||
|
- https://developer.valvesoftware.com/wiki/TF2_Glow_Effect_(2013_SDK) (Glow effect)
|
||||||
|
- https://developer.valvesoftware.com/wiki/CFuncMoveLinear_ParentingFix (func_movelinear parenting fix; Code was improved for Mapbase and the article was later updated with it)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Viewmodel_Prediction_Fix (Viewmodel prediction fix)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Owner#Collisions_with_owner (FSOLID_COLLIDE_WITH_OWNER flag)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Npc_clawscanner#Strider_Scout_Issue (npc_clawscanner strider scout fix)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Ambient_generic:_stop_and_toggle_fix (Fixes for stopping/toggling ambient_generic)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Func_clip_vphysics ("Start Disabled" keyvalue fix)
|
||||||
|
- https://developer.valvesoftware.com/wiki/Importing_CSS_Weapons_Into_HL2 (CS:S viewmodel chirality)
|
||||||
|
|
||||||
|
//---------------------------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
Direct contributions:
|
||||||
|
|
||||||
|
- https://github.com/mapbase-source/source-sdk-2013/pull/3 ("playvideo" command playback fix from Avanate)
|
||||||
|
- https://github.com/mapbase-source/source-sdk-2013/pull/5 (Custom VScript implementation by ReDucTor; was placed into feature branch before being merged in a subsequent PR)
|
||||||
|
- https://github.com/mapbase-source/source-sdk-2013/pull/60 (Adjustment by RoyaleNoir to one of Saul's VDC changes)
|
||||||
|
- https://github.com/mapbase-source/source-sdk-2013/pull/84 (CS:S viewmodel chirality from 1upD)
|
||||||
|
- https://github.com/mapbase-source/source-sdk-2013/pull/116 (vgui_movie_display mute keyvalue from Alivebyte/rzkid)
|
||||||
|
- https://github.com/mapbase-source/source-sdk-2013/pull/140 (logic_substring entity and icon created by moofemp)
|
||||||
|
- https://github.com/mapbase-source/source-sdk-2013/pull/143 (Propper features for VBSP from Matty-64)
|
||||||
|
- Demo autorecord code provided by Klems
|
||||||
|
- cc_emit crash fix provided by 1upD
|
||||||
|
- Custom HL2 ammo crate models created by Rara (Textures created by Blixibon; This is asset-based and, aside from the SLAM crate, not reflected in the code)
|
||||||
|
- Combine lock hardware on door01_left.mdl created by Kralich (This is asset-based and not reflected in the code)
|
||||||
|
- npc_vehicledriver fixes provided by CrAzY
|
||||||
|
- npc_combine cover behavior patches provided by iohnnyboy
|
||||||
|
- logic_playmovie icon created by URAKOLOUY5 (This is asset-based and not reflected in the code)
|
||||||
|
|
||||||
|
== Contributions from samisalreadytaken:
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/47 (VScript utility/consistency changes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/59 (New VScript functions and singletons based on API documentation in later Source/Source 2 games)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/80 (More VScript changes, including support for extremely flexible client/server messaging)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/105 (VScript fixes and optimizations, Vector class extensions, custom convars/commands)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/114 (VScript fixes and extensions)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/122 (Minor VScript-related adjustments)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/148 (Minor fixup)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/167 (Security fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/168 (Squirrel update)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/171 (VScript documentation sorting)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/173 (VScript fixes and optimizations)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/192 (VScript hook manager and fixes)
|
||||||
|
|
||||||
|
== Contributions from z33ky:
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/21 (Various GCC/Linux compilation fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/95 (Additional GCC/Linux compilation fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/117 (Additional GCC/Linux compilation fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/124 (Memory error fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/130 (Memory error fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/131 (env_projectedtexture target shadows fix)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/132 (Console error fix)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/152 (Additional GCC/Linux compilation fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/159 (Additional GCC/Linux compilation fixes)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/162 (VS2019 exception specification fix)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/170 (HL2 non-Episodic build fix)
|
||||||
|
|
||||||
|
== Contributions from Petercov:
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/182 (NPCs load dynamic interactions from all animation MDLs)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/184 (Projected texture horizontal FOV shadow fix)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/185 (Fix enemyfinders becoming visible when they wake)
|
||||||
|
=-- https://github.com/mapbase-source/source-sdk-2013/pull/186 (Fix for brightly glowing teeth)
|
||||||
|
|
||||||
|
//---------------------------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
Other sources:
|
||||||
|
|
||||||
|
- Various code from Source SDK 2013 pull requests on the GitHub repository (https://github.com/ValveSoftware/source-sdk-2013/pulls):
|
||||||
|
-- https://github.com/ValveSoftware/source-sdk-2013/pull/441 (Smooth scrape sound oversight fix)
|
||||||
|
-- https://github.com/ValveSoftware/source-sdk-2013/pull/436 (VRAD debug counter fix + thread bump)
|
||||||
|
-- https://github.com/ValveSoftware/source-sdk-2013/pull/416 (Ragdoll null pointer dereference fix)
|
||||||
|
-- https://github.com/ValveSoftware/source-sdk-2013/pull/401 (func_rot_button "Starts locked" flag fix)
|
||||||
|
-- https://github.com/ValveSoftware/source-sdk-2013/pull/391 (VBSP func_detail smoothing group fix)
|
||||||
|
-- https://github.com/ValveSoftware/source-sdk-2013/pull/362 (npc_manhack npc_maker fix; Adjusted for formatting and save/restore in Mapbase)
|
||||||
|
-- https://github.com/Petercov/Source-PlusPlus/commit/ecdf50c48cd31dec4dbdb7fea2d0780e7f0dd8ec (used as a guide for porting the Alien Swarm SDK response system)
|
||||||
|
- https://github.com/momentum-mod/game/blob/1d066180b3bf74830c51e6914d46c40b0bea1fc2/mp/src/game/server/player.cpp#L6543 (spec_goto fix)
|
||||||
|
- Poison zombie barnacle crash fix implemented based on a snippet from HL2: Plus posted by Agent Agrimar on Discord (Mapbase makes the barnacle recognize it as poison just like poison headcrabs)
|
||||||
|
- https://gamebanana.com/skins/172192 (Airboat handling fix; This is asset-based and not reflected in the code)
|
||||||
|
- Vortigaunt LOS fix originally created by dky.tehkingd.u for HL2:CE
|
||||||
|
- https://combineoverwiki.net/wiki/File:Combine_main_symbol.svg ("icon_combine" instructor icon in "materials/vgui/hud/gameinstructor_hl2_1"; This is asset-based and not reflected in the code)
|
||||||
|
|
||||||
|
//---------------------------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
If there is anything missing from this list, please contact Blixibon.
|
||||||
|
|
||||||
|
//============================================================================================
|
||||||
|
|
||||||
|
Aside from the content list above, Mapbase has more descriptive and up-to-date credits on this wiki article:
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013/wiki/Mapbase-Credits
|
||||||
|
|
||||||
|
Other relevant articles:
|
||||||
|
* https://github.com/mapbase-source/source-sdk-2013/wiki/Mapbase-Disclaimers
|
||||||
|
* https://github.com/mapbase-source/source-sdk-2013/wiki/Frequently-Asked-Questions-(FAQ)
|
||||||
|
|
||||||
|
//---------------------------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
|
||||||
|
In memory of Holly Liberatore (moofemp)
|
||||||
|
|
||||||
|
//============================================================================================
|
11
README.md
Normal file
11
README.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# Mapbase Game Sources
|
||||||
|
|
||||||
|
This repository contains all files which compose Mapbase's mod folders and VPKs, except for compiled files like DLLs. FGDs are also hosted on another repository.
|
||||||
|
|
||||||
|
This repository accepts pull requests for contributing scripts, assets, or other file changes to Mapbase.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Please view `MAPBASE_CONTENT_USAGE.txt` for all information on attribution for this content (including content in the code and elsewhere).
|
||||||
|
|
||||||
|
`README.txt` is distributed with builds.
|
25
README.txt
Normal file
25
README.txt
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
==============================================================
|
||||||
|
Mapbase Release Build
|
||||||
|
v7.0
|
||||||
|
==============================================================
|
||||||
|
|
||||||
|
"Installing" Mapbase is basically just like any other Source mod, except there's three folders instead of one. To install Mapbase, follow these instructions:
|
||||||
|
|
||||||
|
- Install Source SDK Base 2013 Singleplayer and set the branch to -upcoming if you haven’t already.
|
||||||
|
- Extract mapbase_episodic, mapbase_hl2, and mapbase_shared from the .zip archive downloaded earlier to your “SteamApps/sourcemods” directory.
|
||||||
|
- Restart Steam.
|
||||||
|
|
||||||
|
You should now have “Mapbase - Episodic” and “Mapbase - HL2” in your Steam library. If not, make sure you're using the same drive Steam is installed on and ensure that you extracted the folders correctly. (e.g. "SteamApps/sourcemods/mapbase_shared")
|
||||||
|
|
||||||
|
If you have followed all instructions correctly, Mapbase should be fully playable at this point. mapbase_episodic is for the HL2 episodes, mapbase_hl2 is for the original HL2, and mapbase_shared just contains miscellaneous content not unique to Half-Life 2.
|
||||||
|
|
||||||
|
Using Mapbase in Hammer is a bit more complicated and steps for that can be found here:
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013/wiki/Setting-up-Mapbase
|
||||||
|
|
||||||
|
==============================================================
|
||||||
|
https://www.moddb.com/mods/mapbase
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013
|
||||||
|
https://mapbase-source.notion.site/Mapbase-Development-34e27a9892864c96b1e0021ea780d880
|
||||||
|
https://github.com/mapbase-source/source-sdk-2013/issues
|
||||||
|
https://discord.gg/nd8tXNg
|
||||||
|
==============================================================
|
Loading…
Reference in New Issue
Block a user