ACE3/docs
johnb432 c8404f496e
Arsenal - Add/Fix/Improve/Change numerous aspects (#9040)
* Arsenal update

* Fixes

* Update fnc_onSelChangedLeft.sqf

* Update fnc_updateUniqueItemsList.sqf

* Header fixes

* Fix for defines.hpp

Co-authored-by: Dystopian <sddex@ya.ru>

* Moved fnc_baseWeapon, filtered invalid items

* Update addons/arsenal/functions/fnc_scanConfig.sqf

Co-authored-by: Grim <69561145+LinkIsGrim@users.noreply.github.com>

* Fixes and tweaks

- Sorting is guaranteed to give a fixed order
- Dog tags no longer throw errors when reloading the ACE arsenal mission when you had some saved in your loadout before quitting the last time you played.

* Cleanup, bug fixes and additions

- Added the ability to add items from "CfgMagazines" into the "Misc. items" or custom tabs.
- Added "baseWeapon" class support for weapon attachments. If a weapon attachment has the config property "baseWeapon" defined, it will take that item and show that in the arsenal.
- Added stronger filtering on item scopes (scope > 0 at least for every item)
- Added "descending" (default, as it is now) and "ascending" sort order as a drop down menu,
- Unique backpacks in containers can now be removed with either the "-" or "clear all items" button.
- When sorting by a number, 2 decimal points have been added, so that when you sort by weight it returns the correct order.

* More fixes and tweaks

- Converted the arsenal to partially work with hashmaps instead of arrays (for configItems and virtualItems, currentItems is still an array).
- Because of the above, performance of FUNC(addVirtualItems) and FUNC(removeVirtualItems) has improved immensely.
- Sorting now caches results, reducing repeated sorting times drastically.
- CBA disposable launchers are handled differently now: Within the arsenal, you can change weapon attachments on disposable launchers, but you can't change their magazines (primary or secondary). Item info on the right and the stats show correct information.
- FUNC(addSort) now checks if the new sorting method already exists and doesn't add it if it does.
- FUNC(removeSort) now exists. You can't remove the default sort type (alphabetically) to avoid problems with the arsenal.
- Both FUNC(addStat) and FUNC(compileStats) actually taken priority into account now. Because of that priority on several stats needed to be tweaked.
- FUNC(removeStat) ensures that there are no gaps within the stat array (so if there is an empty spot in the stats page, it's because there is a stat, but the condition for it being shown hasn't been met).

* Update fnc_replaceUniqueItemsLoadout.sqf

* Update fnc_onSelChangedLeft.sqf

* Update fnc_scanConfig.sqf

* Update docs/wiki/framework/arsenal-framework.md

Co-authored-by: Grim <69561145+LinkIsGrim@users.noreply.github.com>

* Minor cleanup

* Baseweapon filtering

* Improvements + better unique items support

* Update fnc_fillRightPanel.sqf

* Update fnc_onSelChangedLeft.sqf

Fixed: Switching between weapons with incompatible primary magazines while a compatible secondary magazine is loaded doesn't equip the new weapon's primary magazine.

* Update addons/common/functions/fnc_uniqueUnitItems.sqf

Co-authored-by: PabstMirror <pabstmirror@gmail.com>

* undefined variable

Co-authored-by: PabstMirror <pabstmirror@gmail.com>

* fix undefined loadout var

* Update fnc_fillLoadoutsList.sqf

---------

Co-authored-by: Dystopian <sddex@ya.ru>
Co-authored-by: Grim <69561145+LinkIsGrim@users.noreply.github.com>
Co-authored-by: PabstMirror <pabstmirror@gmail.com>
2023-07-21 21:25:25 +03:00
..
_includes Use function documentation script (#6897) 2023-04-30 23:03:35 +02:00
_layouts Documentation - Add dependencies page (#8706) 2021-12-02 15:40:46 +01:00
_posts replace urls (#8875) 2022-04-14 09:22:23 +02:00
css Documentation - Fix various lighthouse issues (#8600) 2021-10-25 04:26:31 +02:00
img Documentation - Replace all images by webp equivalents (#8594) 2021-10-24 05:10:30 +02:00
js remove google analytics (#8877) 2022-04-16 07:39:42 +02:00
src remove google analytics (#8877) 2022-04-16 07:39:42 +02:00
tools Documentation - Cleanup function documentation output 2023-05-01 17:38:27 +02:00
wiki Arsenal - Add/Fix/Improve/Change numerous aspects (#9040) 2023-07-21 21:25:25 +03:00
_config_dev.yml Cleanup and test pages 2023-05-01 17:03:58 +02:00
_config.yml Cleanup and test pages 2023-05-01 17:03:58 +02:00
.dockerignore Dockerfile (#4550) 2016-10-16 10:48:14 +02:00
.editorconfig merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
.gitattributes Documentation - Replace all images by webp equivalents (#8594) 2021-10-24 05:10:30 +02:00
.gitignore Use function documentation script (#6897) 2023-04-30 23:03:35 +02:00
404.md use md extension (#8680) 2021-11-14 07:45:33 +01:00
acebot.json replace urls (#8875) 2022-04-14 09:22:23 +02:00
CNAME Update CNAME 2022-04-14 03:45:17 +02:00
docker-compose.yml run npm audit fix for docs (#6755) 2019-01-02 00:05:28 +01:00
Dockerfile run npm audit fix for docs (#6755) 2019-01-02 00:05:28 +01:00
entrypoint.sh run npm audit fix for docs (#6755) 2019-01-02 00:05:28 +01:00
favicon-32.png merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
favicon.png merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
Gemfile Fix docker (#6013) 2018-01-03 20:31:30 +01:00
google38c2ed88459ce9b8.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
googlebd2887f5a38652f2.html merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
humans.txt merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
index.html replace chat urls (#8918) 2022-05-22 22:51:49 +02:00
manifest.json add web app manifest 2016-12-27 09:36:18 +01:00
news.md use md extension (#8680) 2021-11-14 07:45:33 +01:00
package-lock.json remove google analytics (#8877) 2022-04-16 07:39:42 +02:00
README_DE.md replace chat urls (#8918) 2022-05-22 22:51:49 +02:00
README_PL.md replace chat urls (#8918) 2022-05-22 22:51:49 +02:00
README.md replace urls (#8875) 2022-04-14 09:22:23 +02:00
README.zh-TW.md replace chat urls (#8918) 2022-05-22 22:51:49 +02:00
robots.txt merge gh-pages content into docs folder 2016-08-18 18:37:38 +02:00
sitemap.xml Documentation - Add dependencies page (#8706) 2021-12-02 15:40:46 +01:00
team.md Docs - Add Grim to maintainers (#9223) 2023-06-19 16:31:17 +03:00
version.md use md extension (#8680) 2021-11-14 07:45:33 +01:00

Source of https://ace3.acemod.org/

Updating compiled JavaScript and CSS files

  • Install Node.js

  • Open Command Prompt and navigate to src directory

    cd <ACE3_directory>/docs/src
    
  • Install Node packages

    npm install
    

    On Bash on Ubuntu on Windows also install nodejs-legacy in case of errors.

  • Update files

    grunt
    

Setting up the Jekyll environment

Using Docker

We include files for Docker to run Jekyll in a separate container. This allows you to not having to install anything apart from Docker on your computer.

Running the Dockerfile

  • Install Docker

  • cd into the /docs/ directory

  • Open Command Prompt and navigate to this directory

    cd <ACE3_directory>/docs
    
  • Build and run the container

    docker-compose up
    
  • Navigate to http://localhost:4000

Manually

Installing prerequisites

Windows (CMD)
  • Install Ruby 2.0.0-p648 (x64)

  • Install Ruby DevKit for 2.0 (x64)

  • Open Command Prompt and navigate to this directory

    cd <ACE3_directory>/docs
    
  • Install bundler gem

    gem install bundler
    
  • Install required gems through bundler

    bundle install
    

Debian / Bash on Ubuntu on Windows

  • Open Bash and navigate to this directory

    cd <ACE3_directory>/docs
    
  • Install make and gcc

    sudo apt-get install make gcc
    
  • Install ruby2.0, ruby2.0-dev and ruby-switch

    sudo apt-add-repository ppa:brightbox/ruby-ng
    sudo apt-get update
    sudo apt-get install ruby2.0 ruby2.0-dev ruby-switch
    
  • Set Ruby version

    sudo ruby-switch --set ruby2.0
    
  • Install bundler

    sudo gem install bundler
    
  • Install required gems through bundler

    bundle install
    
  • In case of sticky folder error during bundle install, execute the following to fix permissions

    find ~/.bundle/cache -type d -exec chmod 0755 {} +
    

Running

  • Run Jekyll through bundler

    bundle exec jekyll serve --future --incremental --config _config_dev.yml
    

    Use --force_polling on Bash on Ubuntu on Windows due to a bug preventing watching.

  • Navigate to http://localhost:4000