ULib Readme

ULib is brought to you by..

• Brett “Megiddo” Smith - Contact: meg.nosp@m.iddo@ulysses.nosp@m.mod.net
• JamminR - Contact: jam.nosp@m.minr@ulysses.nosp@m.mod.net
• Stickly Man!  - Contact: stick.nosp@m.lyman@ulysses.nosp@m.mod.net

ULib requires a working copy of garrysmod 10, and that’s it!

To install ULib, simply extract the files from the archive to your garrysmod/addons folder.  When you’ve done this, you should have a file structure like this-- <garrysmod>/addons/ulib/lua/ULib/init.lua <garrysmod>/addons/ulib/lua/ULib/server/util.lua <garrysmod>/addons/ulib/lua/autorun/ulib_init.lua <garrysmod>/addons/ulib/data/ULib/users.txt etc..

Please note that installation is the same on dedicated servers.

You absolutely, positively have to do a full server restart after installing the files.  A simple map change will not cut it!

Server admins do not “use” ULib, they simply enjoy the benefits it has to offer.  After installing ULib correctly, scripts that take advantage of ULib will take care of the rest.  Rest easy!

• [CHANGE] NumArg now allows for time string format.

• [FIX] Garry breakages.

• [ADD] ULib.ucl.getUserRegisteredID.
• [ADD] ULib.stringTimeToSeconds (Thanks lavacano201014).
• [FIX] Now properly kicks users who are banned while joining (Thanks Willdy).

• [ADD] ULib.tsayColor and Ulib.tsayError
• [ADD] Replicated cvars.  Nearly a direct port from the UPS implementation, with a few improvements.
• [ADD] queueFunctionCall, ported from UPS.
• [ADD] Player:GetUserGroup().
• [ADD] Player:CheckGroup(), ability to check if a user in a group via inheritance.
• [ADD] ULib.getPlyByUID().
• [ADD] ULib.clientRPC(), send massive amounts of data to a client with ease.
• [ADD] Upgrade script.
• [ADD] hook.getCurrentHooks(), returns all currently processing hooks.
• [ADD] hook.isInHook( name ), returns if you’re in the specified hook or not.
• [ADD] ULib.splitPort(), ULib.isValidSteamID(), ULib.isValidIP().
• [ADD] ULib.backupFile().
• [ADD] ULib.throwBadArg(), useful for argument checking.
• [ADD] ULib.checkArg(), useful for argument checking.
• [ADD] ULib.getPicker(), returns a user directly in front of another user.
• [ADD] Utilities for table inheritance.
• [ADD] New ‘translation’ command system that acts as a wrapper between a user and lua.
• [ADD] New (and very different) command system.
• [ADD] Lots of new hooks.
• [ADD] Support for gatekeeper in ULib.kick.
• [ADD] Our own optimized version of datastream, since garry’s implementation is always broken.
• [ADD] ULib.getAllReadyPlayers(), useful for sending usermessages to everyone.
• [ADD] Basic spam detection system for ULib commands.
• [FIX] ULib.filesInDir, was completely broken.
• [FIX] The usual assortment of garry breakages.
• [FIX] Some case-sensitive issues with the ULib add-command functions.
• [FIX] Attempting to delete misc_registered.txt when it didn’t exist.
• [FIX] ULib.splitArgs now really properly handles escaped quotes and now unescapes them.
• [FIX] Concommands created by ULib removing empty args.
• [FIX] Overflowing command buffer when executing large config files.
• [FIX] Optimized various functions to support up to 4000 bans (at least!).
• [FIX] Bug where reloading ban information when a temp ban had less than a minute left made the ban permanent.
• [FIX] Bug where ULib was reading in bad characters from source bans (Thanks edk141).
• [CHANGE] Chat hooks are now a high priority due to other aggressive admin mods overriding ULX.
• [CHANGE] Rewrote UCL entirely.  The upgrade script should take care of bringing over old data into the new system.
• [CHANGE] Added the ability to have access tags for each access string.  These allow the accesses to have customizable behavior.
• [CHANGE] Access tags now have comments attached to them (for the “what is it?” among us).
• [CHANGE] Added lots of keywords (and keyword negation!) to ULib.getUsers and ULib.getUser.
• [CHANGE] Invisible gets rid of shadows now.
• [CHANGE] Garry’s hook table spec is now more closely followed.  (Thanks aVoN!)
• [CHANGE] Moved the hook changes to the shared portion so clients can use the enhanced hooks as well.
• [CHANGE] Updated the hooks file to match garry’s recent changes.  Also increased efficiency in hooks (faster than garry’s!)
• [CHANGE] Slaps now do a view punch as well.
• [CHANGE] Allow nil access on ULib.addSayCommand so that you can create a command you always have access to.
• [CHANGE] ULib.ucl.query always returns true when a nil access string is passed in.
• [REMOVE] Ability to have passwords in UCL, don’t think it worked anymore and it was never really used.
• [REMOVE] Immunity no longer exists, since the new UCL has a much better method of doing the same thing.
• [REMOVE] Some hooks due to garry breakage.
• [REMOVE] Chat sounds on tsay, engine no longer makes sounds so neither should tsay.

• [FIX] Umsgs being sent too early in certain circumstances.
• [FIX] Some issues garry introduced in the Jan09 update regarding player initialization.
• [FIX] ParseKeyValues not unescaping backslashes.
• [CHANGE] Rewrote splitArgs and parseKeyValues.
• [CHANGE] misc_registered.txt now self-destructs on missing or empty groups.txt.
• [CHANGE] All gamemode.Call refs to hook.Call, thanks aVoN!
• [CHANGE] SetUserGroup now REMOVES any other groups and sets an exclusive group.  Sorry about this, but this is for the better.

• [ADD] Support for client/server-side only modules.
• [FIX] Bug in ULib.tsay that would incorrectly print to console if the target player was disconnecting.
• [FIX] Makes sure that prop protectors don’t take ownership of props using physgun reload while a prop is unmovable.
• [CHANGE] ULib.getUsers now returns multiple users on an asterisk “*” when enable_keywords is true.  “<ALL>” can still be used.  (Thanks Kyzer)

• [ADD] ULib now has three shiny new hooks to let you know about client initialization and a new hook to signal a player name change.
• [FIX] A possible bug in the physics helpers.
• [CHANGE] Various things to bring ULib into new engine compatibility.
• [CHANGE] Removed all timers dealing with initialization and now rely on flags from the client.  This makes the ULib initialization much more dependable.
• [CHANGE] Converted all calls from ULib.consoleCommand( “exec ...”  ) to ULib.execFile() to avoid running into the block on “exec” without our module.
• [REMOVE] Removing the module for now, might re-appear in the next version

• [ADD] New hook library.  Completely backwards compatible, but can now do priorities.  (Server-side only)
• [ADD] ULib.parseKeyValues, ULib.makeKeyValues
• [ADD] ULib.getSpawnInfo, ULib.Spawn - Enhanced Spawn... will replace original health/armor when called if getSpawnInfo called first.
• [ADD] READDED hexing system to get around garry’s ConCommand() blocks.  So much is now blocked that it’s interferring with normal ULX operations.
• [ADD] Our server module again.  This time with only console-executing abilities.  This is because garry has blocked much of what we need.  Source is included.
• [ADD] Custom ban list to store temp bans and additional ban info.  Permanent bans are still stored in banned_user.cfg, and the two lists are synchronized.
• [FIX] Can now query players from client side.
• [FIX] An exploit in DisallowDelete() that allowed players to still remove the props
• [FIX] Various initialization functions trying to access a disconnected player
• [FIX] ULib.csay() sending umsgs to invalid players.
• [FIX] UCL by clantag not working.
• [CHANGE] Big changes in ucl.query() and concommand functions.  Probably won’t be backwards compatible.
• [CHANGE] UCL now uses our new keyvalues functions.  It should be backwards compatible with your old data, but we make no promises.  If you’re having trouble with it, try starting from scratch.
• [CHANGE] ULib.tsay has a wait parameter to send on next frame
• [CHANGE] subconcommands are now case insensitive
• [CHANGE] Csay’s now have fade.
• [CHANGE] DisallowSpawning() now implements SpawnObject.  For example, people can’t sit and precache props while in the ulx jail.
• [CHANGE] Say commands are now case insensitive and default to needing a space between command and arg (can flag to use old behavior though)
• [CHANGE] ULib.ban, and ULib.kickban now accept additional information and pass data to ULib.addBan.
• [CHANGE] Immunity is now an access string instead of a group
• [CHANGE] Overcoming immunity is no longer bound to superadmins
• [CHANGE] Increased performance of UCL.
• [REMOVED] The vgui panels, derma is the vgui of choice now.

• [ADD] ply:SetUserGroup() -- Thanks aVoN!
• [ADD] ply:DisallowVehicles( bool )
• [FIX] A timer error in UCL, was messing up scoreboard sometimes.
• [FIX] Security hole where exploiters could gain superadmin access
• [CHANGE] You can assign allow/denies to the default user group, “user” now.  (IE, allow guests to slap)
• [CHANGE] DisallowSpawning now disallows tools that can spawn things.
• [REMOVED] Old settings/users.txt stuff, handled by SetUserGroup now

• [ADD] ULib.isSandbox
• [ADD] Player/ent hooks DisallowMoving, DisallowDeleting, DisallowSpawning, DisallowNoclip
• [ADD] Some vgui libs (URoundButton, URoundMenu)
• [FIX] Double printing in console.
• [CHANGE] Implemented garry’s “proper” way of including c-side files.
• [CHANGE] Implemented client side UCL
• [CHANGE] Now in addon format
• [CHANGE] Slapping noclipped players will take them out of noclip to prevent them flying very far out of the world
• [CHANGE] Improved the umsg send/receive functions
• [REMOVED] Hexing system to get around garry’s ConCommand() blocks.  Very little is blocked now.
• [REMOVED] Dll, MOTD functionality is handled by ULX now.

• [ADD] ULib module, has functions for motd, concommands, and downloading files.  SOURCE CODE!
• [FIX] Player slap after dead problem.

• [ADD] New system for giving files to clients.  Strips comments and puts them in a separate folder.
• [FIX] Autocompletes aren’t handled so hackishly now.  This should fix some occasional errors.
• [FIX] Lots of general fixes.

• [FIX] Importing from garry’s default user file.
• [FIX] All users receiving “you do not have access” message.

• Initial version for GM10

To all developers, I sincerely hope you enjoy what ULib has to offer!  If you have any suggestions, comments, or complaints, please tell us at http://forums.ulyssesmod.net/.

If you want an overview of what’s in ULib, please visit the documentation at http://ulyssesmod.net/docs/

All ULib’s functions are kept in the table “ULib” to prevent conflicts.

Revisions are kept in the function/variable documentation.  If you don’t see revisions listed, it hasn’t changed since v2.0

If you write a script taking advantage of ULib, stick the init script inside ULib/modules.  ULib will load your script after ULib loads, and will send it to and load it on clients as well.

Some important quirks developers should know about --

• autocomplete - You have to define the autocomplete on the client, so if you pass a string for autocomplete to ULib.concommand, it will assume you mean a client function.  There’s also a delay in the sending of these to the client.

Thanks to JamminR, who is always there to offer help and advice to those who need it.

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License.  To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons 543 Howard Street 5th Floor San Francisco, California 94105 USA