From 6afb70afaeb47b3c421d0a72d0f824d5676427d2 Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Sun, 15 Jul 2018 19:58:37 -0400 Subject: Updated documentation * Updated logo * Started a file to make custom css * Updated some documentation --- README.md | 4 +- config.ld | 16 ++- doc/.gitignore | 2 +- doc/ldoc.css | 313 ++++++++++++++++++++++++++++++++++++++++++ logo.png | Bin 41002 -> 40804 bytes tutorials/tut021_detouring.md | 2 + 6 files changed, 330 insertions(+), 7 deletions(-) create mode 100644 doc/ldoc.css diff --git a/README.md b/README.md index b0a2608..0caa2db 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,11 @@ Artery can: * Save and load player data * Spawn npcs that wander around, give quests, trade, and more! * Easily work with external addons so you don't have to make everything yourself -* Load addons to add onto the base +* Load specialized "artery" addons that extend the gamemode base ##Dependencies -As of now, artery depends on the following addons: +Artery depends on the following addons: * bobbleheadbob's zone tool * CapsAdmin's PAC3 (+JetBoom's animbonelib which comes packaged with PAC3) diff --git a/config.ld b/config.ld index 78f49aa..b6337c2 100644 --- a/config.ld +++ b/config.ld @@ -13,11 +13,13 @@ file = { } format = 'markdown' sort_modules = true -new_type("concommand","Console commands", false) -new_type("metamethod","Meta Methods", false) +new_type("concommand","Console commands", true) +new_type("metamethod","Meta Methods", true) + new_type("server","Server Modules", true) new_type("client","Client Modules", true) new_type("shared","Shared Modules", true) + new_type("tutorial","Tutorials",true) custom_tags = { {'reqadmin', hidden=false}, @@ -26,6 +28,9 @@ custom_tags = { custom_display_name_handler = function(item,default_handeler) if item.type == "concommand" then if item.tags.reqadmin then + for k,v in pairs(item) do + print(k,":",v) + end return item.name .. " Requires Admin " end elseif item.type == "domain" then @@ -39,9 +44,11 @@ custom_display_name_handler = function(item,default_handeler) end return default_handeler(item) end +style = "doc" +readme = {"README.md"} -readme = { - "README.md", +--[[ +examples = { "tutorials/tut000_setup.md", "tutorials/tut010_first_addon.md", "tutorials/tut020_nrequire.md", @@ -54,3 +61,4 @@ readme = { "tutorials/tut042_too_many_items.md", "tutorials/tut050_entities.md", } +]] diff --git a/doc/.gitignore b/doc/.gitignore index bbc3411..f0f4589 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,2 +1,2 @@ *.html -*.css +ldoc_fixed.css diff --git a/doc/ldoc.css b/doc/ldoc.css new file mode 100644 index 0000000..6f22dc8 --- /dev/null +++ b/doc/ldoc.css @@ -0,0 +1,313 @@ +/* BEGIN RESET + +Copyright (c) 2010, Yahoo! Inc. All rights reserved. +Code licensed under the BSD License: +http://developer.yahoo.com/yui/license.html +version: 2.8.2r1 +*/ +html { + color: #000; + background: #FFF; +} +em { + color: #f00; +} +body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td { + margin: 0; + padding: 0; +} +table { + border-collapse: collapse; + border-spacing: 0; +} +fieldset,img { + border: 0; +} +address,caption,cite,code,dfn,em,strong,th,var,optgroup { + font-style: inherit; + font-weight: inherit; +} +del,ins { + text-decoration: none; +} +li { + margin-left: 20px; +} +caption,th { + text-align: left; +} +h1,h2,h3,h4,h5,h6 { + font-size: 100%; + font-weight: bold; +} +q:before,q:after { + content: ''; +} +abbr,acronym { + border: 0; + font-variant: normal; +} +sup { + vertical-align: baseline; +} +sub { + vertical-align: baseline; +} +legend { + color: #000; +} +input,button,textarea,select,optgroup,option { + font-family: inherit; + font-size: inherit; + font-style: inherit; + font-weight: inherit; +} +input,button,textarea,select {*font-size:100%; +} +/* END RESET */ + +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color: #ffffff; margin: 0px; +} + +code, tt { font-family: monospace; font-size: 1.1em; } +span.parameter { font-family:monospace; } +span.parameter:after { content:":"; } +span.types:before { content:"("; } +span.types:after { content:")"; } +.type { font-weight: bold; font-style:italic } + +body, p, td, th { font-size: .95em; line-height: 1.2em;} + +p, ul { margin: 10px 0 0 0px;} + +strong { font-weight: bold;} + +em { font-style: italic;} + +h1 { + font-size: 1.5em; + margin: 0 0 20px 0; +} +h2, h3, h4 { margin: 15px 0 10px 0; } +h2 { font-size: 1.25em; } +h3 { font-size: 1.15em; } +h4 { font-size: 1.06em; } + +a:link { font-weight: bold; color: #004080; text-decoration: none; } +a:visited { font-weight: bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration: underline; } + +hr { + color:#cccccc; + background: #00007f; + height: 1px; +} + +blockquote { margin-left: 3em; } + +ul { list-style-type: disc; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; +} + +pre { + background-color: rgb(245, 245, 245); + border: 1px solid #C0C0C0; /* silver */ + padding: 10px; + margin: 10px 0 10px 0; + overflow: auto; + font-family: "Andale Mono", monospace; +} + +pre.example { + font-size: .85em; +} + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #ffffff; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#main { + background-color:#FFFFFF; // #f0f0f0; + border-left: 1px solid #cccccc; +} + +#navigation { + position: fixed; + top: 0; + left: 0; + float: left; + width: 14em; + vertical-align: top; + background-color:#FFFFFF; // #f0f0f0; + border-right: 2px solid #cccccc; + overflow: visible; + overflow-y: scroll; + height: 100%; + padding-left: 1em; +} + +#navigation h2 { + background-color:#FFFFFF;//:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align: left; + padding:0.2em; + border-bottom:1px solid #dddddd; +} + +#navigation ul +{ + font-size:1em; + list-style-type: none; + margin: 1px 1px 10px 1px; +} + +#navigation li { + text-indent: -1em; + display: block; + margin: 3px 0px 0px 22px; +} + +#navigation li li a { + margin: 0px 3px 0px -1em; +} + +#content { + margin-left: 14em; + padding: 1em; + padding-left: 2em; + width: 700px; + border-left: 2px solid #cccccc; + // border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + padding-left: 1em; + margin-left: 14em; // avoid the damn sidebar! + border-top: 2px solid #cccccc; + border-left: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 12pt "Times New Roman", "TimeNR", Times, serif; + } + a { font-weight: bold; color: #004080; text-decoration: underline; } + + #main { + background-color: #ffffff; + border-left: 0px; + } + + #container { + margin-left: 2%; + margin-right: 2%; + background-color: #ffffff; + } + + #content { + padding: 1em; + background-color: #ffffff; + } + + #navigation { + display: none; + } + pre.example { + font-family: "Andale Mono", monospace; + font-size: 10pt; + page-break-inside: avoid; + } +} + +table.module_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.module_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.module_list td.name { background-color: #f0f0f0; ; min-width: 200px; } +table.module_list td.summary { width: 100%; } + +table.function_list { + border-width: 1px; + border-style: solid; + border-color: #cccccc; + border-collapse: collapse; +} +table.function_list td { + border-width: 1px; + padding: 3px; + border-style: solid; + border-color: #cccccc; +} +table.function_list td.name { background-color: #f6f6ff; ; min-width: 200px; } +table.function_list td.summary { width: 100%; } + +dl.table dt, dl.function dt {border-top: 1px solid #ccc; padding-top: 1em;} +dl.table dd, dl.function dd {padding-bottom: 1em; margin: 10px 0 0 20px;} +dl.table h3, dl.function h3 {font-size: .95em;} + +ul.nowrap { + overflow:auto; + whitespace:nowrap; +} + +/* stop sublists from having initial vertical space */ +ul ul { margin-top: 0px; } +ol ul { margin-top: 0px; } +ol ol { margin-top: 0px; } +ul ol { margin-top: 0px; } + +/* make the target distinct; helps when we're navigating to a function */ +a:target + * { + background-color: #FF9; +} + + +/* styles for prettification of source */ +pre .comment { color: #558817; } +pre .constant { color: #a8660d; } +pre .escape { color: #844631; } +pre .keyword { color: #aa5050; font-weight: bold; } +pre .library { color: #0e7c6b; } +pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; } +pre .string { color: #8080ff; } +pre .number { color: #f8660d; } +pre .operator { color: #2239a8; font-weight: bold; } +pre .preprocessor, pre .prepro { color: #a33243; } +pre .global { color: #800080; } +pre .user-keyword { color: #800080; } +pre .prompt { color: #558817; } +pre .url { color: #272fc2; text-decoration: underline; } diff --git a/logo.png b/logo.png index bd13795..f1cfcc9 100644 Binary files a/logo.png and b/logo.png differ diff --git a/tutorials/tut021_detouring.md b/tutorials/tut021_detouring.md index a03a31d..baf6b08 100644 --- a/tutorials/tut021_detouring.md +++ b/tutorials/tut021_detouring.md @@ -28,4 +28,6 @@ garrysmod/addons/artery\_rougelite/trace\_errors.lua For more information on colortheme.lua see @{colortheme.lua}, for more on debug.traceback() see [the gmod wiki](http://wiki.garrysmod.com/page/debug/traceback). +***Note*** : When detouring, mind the order that you do your logic and the logic that was there before. Does it make sense to do your function first? Maybe it makes more sense to do the usual logic, then come back to your function to do more stuff. + Next tutorial: @{tut030_inventories.md} -- cgit v1.2.3-70-g09d2