Install: Difference between revisions

From Entropy
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
Download the files (1 zip and 1 [custom.inc](https://entropy.exspes.com/file/custom.inc)) 
tl;dr - Download the zip [https://gitlab.com/exspes/entropy/-/archive/master/entropy-master.zip Entropy] and extract the zip in the macros folder of MQ. Copy the [https://entropy.exspes.com/file/custom.inc custom.inc] in to the data folder   
Extract the zip in the macros folder of MQ
Start the mac up.
Copy the [custom.inc](https://entropy.exspes.com/file/custom.inc) in to the data folder   
Start the mac up
<br />
<br />
 
 
 
= Download =
= Download =
Obtain a copy of the macro [here](https://gitlab.com/exspes/entropy/-/archive/master/entropy-master.zip
Obtain a copy of the macro here: [https://gitlab.com/exspes/entropy/-/archive/master/entropy-master.zip Entropy]<br/>
 
 
== folders ==
== folders ==
Once you have downloaded the macro, install it in the following folders.
Once you have downloaded the macro, install it in the following folders.


`macros/entropy` - Contains all the main macro and main database file
<code>macros/entropy</code> - Contains all the main macro and main database file<br/>
`macros/entropy/inc` - Contains all the macro includes
<code>macros/entropy/inc</code> - Contains all the macro includes<br/>
`macros/entropy/data` - Will contain all files the macro creates
<code>macros/entropy/data</code> - Will contain all files the macro creates<br/>
<code>macros/entropy/lua</code> - Contains all the Lua files


****Add**** the [custom.inc](https://entropy.exspes.com/file/custom.inc) file to your data directory (right click, save as)
<br />Add [https://entropy.exspes.com/file/custom.inc custom.inc] file to your data directory (Right click-save as)<br />
<br />


<img alt="File:Install directory.PNG" src="/wiki/images/9/95/Install_directory.PNG" decoding="async" width="668" height="352">
<strong>It is YOUR job to backup the data folder</strong>
<br />
***It is YOUR job to backup the data folder***


== files ==
== files ==
 
[[File:Install directory.png|thumb|alt=|none]]
=== macros/entropy ===
<pre>
<pre>
macros/entropy
changelog.txt - macro history of changes   
changelog.txt - macro history of changes   
start.mac - main macro   
start.mac - main macro   
Line 35: Line 24:
</pre>
</pre>


=== macros/entropy/inc ===
<pre>
<pre>
macros/entropy/inc
class.ber.inc - berserker
class.ber.inc - berserker
class.brd.inc - bard
class.brd.inc - bard
Line 60: Line 49:
</pre>
</pre>


=== macros/entropy/data ===
<pre>
<pre>
macros/entropy/data
custom.inc - all of your custom routines (this file is not includes. DL and add it)
custom.inc - all of your custom routines (this file is not includes. DL and add it)
all custom character databases - added on mac first start
all custom character databases - added on mac first start
Line 77: Line 66:
mq2nav
mq2nav
mq2dannet
mq2dannet
MQ2lua
mq2sqlite
mq2sqlite
mq2map
mq2labels
mq2eqbugfix
mq2custombinds
</pre>
</pre>
All of these plugins are available on Builder, RedGuides and MMOBugs<br/>
All of these plugins are available on Builder, RedGuides and MMOBugs<br/>


=== Lua ===
Set the Lua Required Path to be: <code>macros\entropy\lua\?.lua</code>
[[File:LuaSettings.png|alt=Lua Require Paths|none|thumb|Lua Require Paths]]




= Starting =
= Starting =
Do a `/mac entropy\start.mac
Do a <code>/mac entropy\start.mac</code>
if it yells at you for not having some plugins started, start them up and try the command again.   
if it yells at you for not having some plugins started, start them up and try the command again.   


When you see something along this line
When you see something along this line<br/>
```
<pre>
Entropy::200707.01
Entropy::200707.01
Palatial Guild Hall::guildhalllrg_int
Palatial Guild Hall::guildhalllrg_int
Help::/aux or /command aux
Help::/aux or /command aux
Ready::3.35s
Ready::3.35s
``` 
</pre>
You are right as rain.. (your numbers may vary)   
You are right as rain.. (your numbers may vary)   


Line 103: Line 92:
New builds and update with database changes will always take a little longer. It is advised you start 1 toon up first, let the changes be made, then start the remaining toons.   
New builds and update with database changes will always take a little longer. It is advised you start 1 toon up first, let the changes be made, then start the remaining toons.   


A new start looks like so:
A new start looks like so:<br/>
<div style="float:none;">
<div style="float:none;">
<video src="https://entropy.exspes.com/wiki/images/4/4b/Mac_start_complete.mp4" controls="">
<video src="https://entropy.exspes.com/wiki/images/4/4b/Mac_start_complete.mp4" controls="">
Line 110: Line 99:


== options ==
== options ==
You can start the mac with up to four (4) options.
You can start the mac with up to four (4) options.<br/>


{| class="wikitable" style="text-align: left;"
|-
|-
|auto
|[True/False] allows you to start the mac in auto.. or not..
|-
|debug
|allows you to start the mac with a debug option enabled
|}


|option|value|des|
|---|---|---|
|auto|TRUE/FALSE|allows you to start the mac in auto.. or not..|
|debug|(see /debug)|allows you to start the mac with a debug option enabled|


Example:
Example:
`/mac entropy\start.mac debug:cast auto:true debug:rez
<code>/mac entropy\start.mac debug:cast auto:true debug:rez</code><br/>


Order is not important, syntax is.
Order is not important, syntax is.


= custom.inc =
= custom.inc =
Add the [custom.inc](https://entropy.exspes.com/file/custom.inc) file to your data directory (right click, save as) 
The custom.inc file is kept complete separate so it will never get overwritten on a DL/update/whatever.<br/>
<br />
All custom hooks, subs, engine settings will go in this file. What you do in here is your business. There is no support for it.<br/>
The custom.inc file is kept complete separate so it will never get overwritten on a DL/update/whatever.  
 
All custom hooks, subs, engine settings will go in this file. What you do in here is your business. There is no support for it.

Latest revision as of 21:52, 26 November 2022

tl;dr - Download the zip Entropy and extract the zip in the macros folder of MQ. Copy the custom.inc in to the data folder Start the mac up.

Download

Obtain a copy of the macro here: Entropy

folders

Once you have downloaded the macro, install it in the following folders.

macros/entropy - Contains all the main macro and main database file
macros/entropy/inc - Contains all the macro includes
macros/entropy/data - Will contain all files the macro creates
macros/entropy/lua - Contains all the Lua files


Add custom.inc file to your data directory (Right click-save as)

It is YOUR job to backup the data folder

files

macros/entropy

changelog.txt - macro history of changes  
start.mac - main macro  
entropy.sqlite - main macro data repository  

macros/entropy/inc

class.ber.inc - berserker
class.brd.inc - bard
class.bst.inc - beastlord
class.clr.inc - cleric
class.dru.inc - druid
class.enc.inc - enchanter
class.mag.inc - magician
class.mnk.inc - monk
class.nec.inc - necromancer
class.pal.inc - paladin
class.rng.inc - ranger
class.rog.inc - rogue
class.shd.inc - shadowknight
class.shm.inc - shaman
class.war.inc - warrior
class.wiz.inc - wizard
common.inc - all common subs/functions
control.inc - all / commands and binds
events.inc - all events
initialize.inc - all mac startup and initialization routines
mode.inc - all off design modes

macros/entropy/data

custom.inc - all of your custom routines (this file is not includes. DL and add it)
all custom character databases - added on mac first start
zone database - added on mac first start
shared database - added on mac first start
loot database - added on mac first start

Plugins

The following plugins are required.

mq2collections
mq2moveutils
mq2nav
mq2dannet
MQ2lua
mq2sqlite

All of these plugins are available on Builder, RedGuides and MMOBugs

Lua

Set the Lua Required Path to be: macros\entropy\lua\?.lua

Lua Require Paths
Lua Require Paths


Starting

Do a /mac entropy\start.mac if it yells at you for not having some plugins started, start them up and try the command again.

When you see something along this line

Entropy::200707.01
Palatial Guild Hall::guildhalllrg_int
Help::/aux or /command aux
Ready::3.35s

You are right as rain.. (your numbers may vary)

new build

New builds and update with database changes will always take a little longer. It is advised you start 1 toon up first, let the changes be made, then start the remaining toons.

A new start looks like so:

Note the delay on the character schema update. This portion will always take the longest.

options

You can start the mac with up to four (4) options.

auto [True/False] allows you to start the mac in auto.. or not..
debug allows you to start the mac with a debug option enabled


Example: /mac entropy\start.mac debug:cast auto:true debug:rez

Order is not important, syntax is.

custom.inc

The custom.inc file is kept complete separate so it will never get overwritten on a DL/update/whatever.
All custom hooks, subs, engine settings will go in this file. What you do in here is your business. There is no support for it.