├── .devcontainer
├── devcontainer.json
└── docker-compose.yml
├── .github
├── config.sh
├── docker-compose.dev-server.yml
├── docker-compose.dry-run.yml
└── workflows
│ └── test-install.yml
├── .gitignore
├── .vscode
└── settings.json
├── LICENSE
├── README.md
├── _config.yml
├── conf
└── dist
│ ├── .env
│ └── docker-compose.override.yml
├── docker-compose.yml
├── scripts
├── lua
│ └── .gitkeep
└── typescript
│ ├── .gitkeep
│ ├── examples
│ └── example.ts
│ ├── package.json
│ └── tsconfig.json
└── var
├── .gitkeep
└── shared
└── .gitkeep
/.devcontainer/devcontainer.json:
--------------------------------------------------------------------------------
1 | // If you want to run as a non-root user in the container, see .devcontainer/docker-compose.yml.
2 | {
3 | "name": "ac-dev-server",
4 |
5 | // Update the 'dockerComposeFile' list if you have more compose files or use different names.
6 | // set an empty array to automatically solve
7 | // the docker-compose files (including the .override.yml)
8 | // https://github.com/microsoft/vscode-remote-release/issues/1080#issuecomment-824213014
9 | // it requires vscode 1.57+
10 | "dockerComposeFile": [],
11 | // The 'service' property is the name of the service for the container that VS Code should
12 | // use. Update this value and .devcontainer/docker-compose.yml to the real service name.
13 | "service": "ac-dev-server",
14 |
15 | // The optional 'workspaceFolder' property is the path VS Code should open by default when
16 | // connected. This is typically a file mount in .devcontainer/docker-compose.yml
17 | "workspaceFolder": "/azerothcore",
18 |
19 | // Add the IDs of extensions you want installed when the container is created.
20 | "extensions": [
21 | "notskm.clang-tidy",
22 | "xaver.clang-format",
23 | "bbenoist.doxygen",
24 | "ms-vscode.cpptools",
25 | "austin.code-gnu-global",
26 | "twxs.cmake",
27 | "mhutchie.git-graph",
28 | "github.vscode-pull-request-github",
29 | "eamodio.gitlens",
30 | "cschlosser.doxdocgen",
31 | "sanaajani.taskrunnercode",
32 | "donjayamanne.githistory"
33 | ],
34 |
35 | // Use 'forwardPorts' to make a list of ports inside the container available locally.
36 | // "forwardPorts": [],
37 |
38 | // Uncomment the next line if you want start specific services in your Docker Compose config.
39 | "runServices": ["ac-dev-server", "ac-dev-database"],
40 |
41 | // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
42 | // "shutdownAction": "none",
43 |
44 | // Uncomment the next line to run commands after the container is created - for example installing curl.
45 | // "postCreateCommand": "apt-get update && apt-get install -y curl",
46 |
47 | // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
48 | "remoteUser": "acore"
49 | }
50 |
--------------------------------------------------------------------------------
/.devcontainer/docker-compose.yml:
--------------------------------------------------------------------------------
1 | version: '3.9'
2 | services:
3 | # Update this to the name of the service you want to work with in your docker-compose.yml file
4 | ac-dev-server:
5 | # If you want add a non-root user to your Dockerfile, you can use the "remoteUser"
6 | # property in devcontainer.json to cause VS Code its sub-processes (terminals, tasks,
7 | # debugging) to execute as the user. Uncomment the next line if you want the entire
8 | # container to run as this user instead. Note that, on Linux, you may need to
9 | # ensure the UID and GID of the container user you create matches your local user.
10 | # See https://aka.ms/vscode-remote/containers/non-root for details.
11 | #
12 | # user: vscode
13 |
14 | # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer
15 | # folder. Note that the path of the Dockerfile and context is relative to the *primary*
16 | # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
17 | # array). The sample below assumes your primary file is in the root of your project.
18 | #
19 | # build:
20 | # context: .
21 | # dockerfile: .devcontainer/Dockerfile
22 |
23 | #volumes:
24 | # Update this to wherever you want VS Code to mount the folder of your project
25 | #- .:/workspace:cached
26 |
27 | # Uncomment the next line to use Docker from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker-compose for details.
28 | # - /var/run/docker.sock:/var/run/docker.sock
29 |
30 | # Uncomment the next four lines if you will use a ptrace-based debugger like C++, Go, and Rust.
31 | # cap_add:
32 | # - SYS_PTRACE
33 | # security_opt:
34 | # - seccomp:unconfined
35 | tty: true
36 |
--------------------------------------------------------------------------------
/.github/config.sh:
--------------------------------------------------------------------------------
1 | CDEBUG=OFF
2 | CTYPE=Release
3 | CAPPS_BUILD=none
4 | CTOOLS_BUILD=db-only
5 |
6 |
--------------------------------------------------------------------------------
/.github/docker-compose.dev-server.yml:
--------------------------------------------------------------------------------
1 | version: '3.9'
2 |
3 | services:
4 | ac-dev-server:
5 | volumes:
6 | - ./config.sh:/azerothcore/conf/config.sh
7 |
--------------------------------------------------------------------------------
/.github/docker-compose.dry-run.yml:
--------------------------------------------------------------------------------
1 | version: '3.9'
2 |
3 | services:
4 | ac-worldserver:
5 | command: env/dist/bin/worldserver -dry-run
6 | restart: "no"
7 | ac-authserver:
8 | command: env/dist/bin/authserver -dry-run
9 | restart: "no"
10 |
--------------------------------------------------------------------------------
/.github/workflows/test-install.yml:
--------------------------------------------------------------------------------
1 | name: Test Installation Process
2 | on:
3 | push:
4 | branches:
5 | - 'master'
6 | pull_request:
7 | workflow_dispatch:
8 | repository_dispatch:
9 |
10 | concurrency:
11 | group: ${{ github.head_ref }} || concat(${{ github.ref }}, ${{ github.workflow }})
12 | cancel-in-progress: true
13 |
14 | jobs:
15 | test-install-process:
16 | env:
17 | COMPOSE_DOCKER_CLI_BUILD: 1
18 | DOCKER_BUILDKIT: 1
19 | BUILDKIT_INLINE_CACHE: 1
20 | runs-on: ${{ matrix.os }}
21 | strategy:
22 | matrix:
23 | include:
24 | # - os: macos-latest TODO: install docker
25 | - os: ubuntu-20.04
26 | - os: ubuntu-latest
27 | # - os: windows-latest TODO: install docker
28 | steps:
29 | - uses: actions/checkout@v2
30 |
31 | - name: Configure
32 | run: |
33 | docker --version
34 | docker compose version
35 |
36 | - name: Test
37 | shell: bash
38 | run: |
39 | cp .github/docker-compose.dry-run.yml docker-compose.override.yml
40 | docker compose up --attach ac-db-import --attach ac-worldserver --attach ac-authserver
41 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /docker-compose.override.yml
2 | /scripts/*
3 | !/scripts/*/
4 | /scripts/*/*
5 | !/scripts/*/.gitkeep
6 | !/scripts/typescript/examples
7 | !/scripts/typescript/tsconfig.json
8 | !/scripts/typescript/package.json
9 | /var/*
10 | !/var/.gitkeep
11 | !/var/shared
12 | /var/shared/*
13 | !/var/shared/.gitkeep
14 | /conf/*
15 | !/conf/dist
16 |
17 | /.env
18 |
19 | !.gitkeep
20 |
21 | npm_modules
--------------------------------------------------------------------------------
/.vscode/settings.json:
--------------------------------------------------------------------------------
1 | {
2 | "deno.enable": false
3 | }
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ACore docker compose
2 |
3 |
4 |
5 | * Table of Contents
6 | {:toc}
7 |
8 | Video Demo:
9 |
10 | [](https://www.youtube.com/watch?v=ldDkI2R431k)
11 |
12 | The docker compose file included in this folder provides an easy way to use the azerothcore images available on [docker hub](https://hub.docker.com/u/acore) .
13 | It means that you will be able to run a clean azerothcore server without installing anything but docker.
14 |
15 | NOTE: You can re-use this docker compose configuration inside another project to test AzerothCore together
16 | with another application, for instance an API or a website based on docker compose.
17 |
18 | The original repository with the sources and the workflows to generate the images used by this docker compose is available [here](https://github.com/azerothcore/azerothcore-wotlk)
19 |
20 | Do you have any questions? Open an [issue here](https://github.com/azerothcore/acore-docker/issues)
21 |
22 | ## Requirements
23 |
24 | * [Docker](https://docs.docker.com/get-docker/)
25 | * [Git](https://git-scm.com/downloads) to clone our repo (suggested), otherwise you can manually [download it](https://github.com/azerothcore/acore-docker/archive/refs/heads/master.zip)
26 |
27 | ## Getting started
28 |
29 | First of all, download or clone [this repository](https://github.com/azerothcore/acore-docker).
30 | If you want to clone the repo you have to open a terminal and run this command: **git clone https://github.com/azerothcore/acore-docker**
31 |
32 | To open a terminal inside a specific folder in your operating system check [this interesting article](https://www.groovypost.com/howto/open-command-window-terminal-window-specific-folder-windows-mac-linux/)
33 |
34 | Now run this magic command sequence inside the downloaded folder to have everything up and running (with an interactive worldserver terminal):
35 |
36 | ```Bash
37 | docker compose up
38 | ```
39 |
40 | **Wait for few minutes and you have an up and running AzerothCore!**
41 |
42 | The first installation will take a while because it needs to download the images from the docker hub and create the entire database before running the server**
43 |
44 | ⚠️ WARNING ⚠️: if you encounter the error `ERROR: for ac-worldserver Container "abcdefg12345" exited with code 1.` or `ERROR: 'network_mode' and 'networks' cannot be combined` please update docker and docker-compose to the latest version.
45 |
46 | ### How to run in background
47 |
48 | If you need to run them in background instead you can use the following command:
49 |
50 | ```Bash
51 | docker compose up -d
52 | ```
53 |
54 | **IMPORTANT:**
55 |
56 | * If the application crashes, docker will automatically restart the container for you
57 |
58 | ## Access the worlserver console and create an account
59 |
60 | With **docker compose up** we have an up and running worldserver as well, but you need to access its interactive shell to
61 | run commands on the worldserver.
62 |
63 |
64 | Open another terminal and use this command to access the worldserver console
65 |
66 | ```Bash
67 | docker attach acore-docker-ac-worldserver-1
68 | ```
69 |
70 | Now you can use the worlserver console to run azerothcore commands.
71 |
72 | To create an account you can use: `account create `
73 |
74 | NOTE: you can detach from a container and leave it running using the CTRL-p CTRL-q key sequence.
75 |
76 | The list of GM commands is available [here](https://www.azerothcore.org/wiki/GM-Commands)
77 |
78 | Do you need a **game client**? check [this page](https://www.azerothcore.org/wiki/client-setup)!
79 |
80 |
81 | **IMPORTANT** to read the list of all the containers you can attach to, run the `docker ps` command.
82 |
83 | ## Ask for support
84 |
85 | If you need support about the docker installation, use one of the following channels:
86 |
87 | * Join our discord community: https://discord.gg/mMgdcx37bA
88 | * Report an issue on github: https://github.com/azerothcore/acore-docker/issues
89 |
90 | If your issue is about the server or you want to report a bug, check our page on [How to ask for help](https://www.azerothcore.org/wiki/how-to-ask-for-help)
91 |
92 |
93 | ## Stop or restart the services
94 |
95 | There are several commands to stop or restart the services, depending on your needs:
96 |
97 | * **docker compose ps**: list all the running containers
98 | * **docker compose stop** : just stops the current running services
99 | * **docker compose restart** : restarts the current running services
100 | * **docker compose down --remove-orphans** : stops and removes the containers.
101 | * **docker compose down --rmi all -v --remove-orphans** : ⚠️ stops, removes, and deletes EVERYTHING. Including the volumes with the associated database ⚠️
102 |
103 | ## Update your services with latest images
104 |
105 | You just need to combine the following commands:
106 |
107 | ```Bash
108 | docker compose down
109 | docker compose pull
110 | docker compose rm -s -v -f ac-client-data
111 | ```
112 |
113 | **NOTE:** `docker compose rm -s -v -f ac-client-data` is used to recreate the client data volume with the newest files.
114 | If you're using your own maps, you should not use this command and regenerate the maps by your own instead (read the paragraph below)
115 |
116 | ## Dev server
117 |
118 | The ac-dev-server is a special container that provides a complete workspace that includes all the sources and dependencies to build your own server.
119 | The container of the ac-dev-server is an isolated instance, it doesn't expose any file with the host and all the changes are stored into a docker volume.
120 | This image is intended to be used together with the [VSCode Docker extension](https://code.visualstudio.com/docs/containers/overview).
121 |
122 | The quickest way to access and work with the ac-dev-server is the following:
123 |
124 | 1. Run this command to stop all the containers: `docker compose down`
125 |
126 | 2. Install [visual studio code](https://code.visualstudio.com/) and the [Remote Development extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
127 |
128 |
129 | 3. Start VS Code in the acore-docker folder, run the `Dev Containers: Reopen in container...` command from the Command Palette (F1) or quick actions Status bar item (green button on the bottom left of your screen)
130 |
131 | 
132 |
133 | 4. Once inside the container open a vscode terminal and run this command
134 |
135 | ```bash
136 | git config --global --add safe.directory '*' && git reset --hard && git pull origin master
137 | ```
138 |
139 | You will notice that the file list available in VSCode is basically the [azerothcore-wotlk](https://github.com/azerothcore/azerothcore-wotlk) repository.
140 | 5. Now you can start working with the azerothcore sources into a pre-configured ubuntu environment with all the dependencies pre-installed
141 | 6. To build and run your server run `./acore.sh compiler build` command. You can refer to [this guide](https://www.azerothcore.org/wiki/ac-dashboard-core-installation) at the paragraph "Build everything from scratch".
142 | 7. Once it's done you can download the client data by executing this command: `./acore.sh client data`
143 | 8. Finally you should be ready to run the authserver and the worldserver available inside the `env/dist/bin` folder. You can also use the restarters
144 | available in the `./acore.sh` dashboard
145 |
146 | IMPORTANT:
147 |
148 | * This container uses a different instance of the mysql database. It means that you won't have, by default, the same data available on the `ac-authserver` and `ac-worldserver` services
149 |
150 | * The dev-server docker compose exposes the following ports: 3724 (authserver), 8085 (worldserver), 7878 (soap service)
151 |
152 | * To share files between your host and the dev-server you can use the `var/shared` folder
153 |
154 | * This dev-container includes all the tools needed to build the AC without configure anything. Look around and play with the vscode workspace to discover all the features available.
155 |
156 | * if you have any file permission issues once inside the container, please run this command:
157 | `sudo chown acore:acore -R .`
158 |
159 |
160 | ## Customize your server
161 |
162 | *NOTE: to unlock 100% power of AzerothCore, please use the [main repo](https://github.com/azerothcore/azerothcore-wotlk) and [compile it by your self](https://www.azerothcore.org/wiki/Installation)!*
163 |
164 | Despite using the [GM commands](https://www.azerothcore.org/wiki/GM-Commands) to operate within the CLI or in game, you have the flexibility to extend/configure
165 | your server with the following techniques:
166 |
167 |
168 | ### Change your docker configurations with the environment variables
169 |
170 | Within the **/conf/dist** folder you can find a sample of the **.env** file which you can copy inside the root folder of this project to
171 | change certain **docker compose** configurations, such as changing the ports of your docker services or the volumes path etc.
172 |
173 | Check the comments inside that file to understand how to use those variables.
174 | ### Extends the default docker compose
175 |
176 | With the combination of the [docker compose.override](https://docs.docker.com/compose/extends/) and the environment variables available to configure
177 | the AzerothCore project, you can extend this docker by adding external and shared volumes, change configurations and even add multiple realms.
178 |
179 | ### How to create a second multirealm environment
180 |
181 | Check the /conf/dist folder that contains an override file ready to be used to implement a secondary worldserver. Just copy-paste this file in the same folder of the `docker-compose.yml`
182 |
183 | You also need to create a `worldserver2.conf` file under the `conf/` folder. You can do that by running this command:
184 |
185 | ```docker compose cp ac-worldserver:/azerothcore/env/dist/etc/worldserver.conf conf/worldserver2.conf```
186 |
187 | Create the following configurations inside the worldserver2.conf:
188 |
189 | ```
190 | RealmID = 2
191 | LoginDatabaseInfo = "ac-database;3306;root;password;acore_auth"
192 | WorldDatabaseInfo = "ac-database;3306;root;password;acore_world2"
193 | CharacterDatabaseInfo = "ac-database;3306;root;password;acore_characters2"
194 | ```
195 |
196 | Finally you need to access your database and change the ```acore_auth.realmlist``` table by adding a second realm with the port ```8086```
197 |
198 | Now you can restart your containers by running:
199 |
200 | ```
201 | docker compose down
202 | docker compose up
203 | ```
204 |
205 | ### Changing your server configurations
206 |
207 | To change the `*.conf` files of your server you need to extract them from the container and then create a volume to re-inject the modified file
208 | into the container again.
209 |
210 | To do this you can use these commands to copy the files from the container to your conf folder:
211 |
212 | ```
213 | docker compose cp ac-worldserver:/azerothcore/env/dist/etc/authserver.conf conf
214 | docker compose cp ac-worldserver:/azerothcore/env/dist/etc/worldserver.conf conf
215 | docker compose cp ac-worldserver:/azerothcore/env/dist/etc/dbimport.conf conf
216 | ```
217 |
218 | then create a `docker-compose.override.yml` file in the same folder of the `docker-compose.yml` file
219 | and add this configurations:
220 |
221 | ```
222 | version: '3.9'
223 |
224 | services:
225 | ac-worldserver:
226 | volumes:
227 | - ./conf/worldserver.conf:/azerothcore/env/dist/etc/worldserver.conf
228 | - ./conf/authserver.conf:/azerothcore/env/dist/etc/authserver.conf
229 | - ./conf/dbimport.conf:/azerothcore/env/dist/etc/dbimport.conf
230 | ```
231 |
232 | In this way you can inject the 3 extracted files from your host into the container
233 |
234 | Now you can change the configurations as you wish and restart the server.
235 |
236 | You can find the list of all the configurations available in these files:
237 |
238 | 1. [worldserver.conf](https://github.com/azerothcore/azerothcore-wotlk/blob/master/src/server/apps/worldserver/worldserver.conf.dist)
239 | 2. [authserver.conf](https://github.com/azerothcore/azerothcore-wotlk/blob/master/src/server/apps/authserver/authserver.conf.dist)
240 |
241 | ### Customize your server with the database
242 |
243 | The database service available within the docker compose expose a mysql port that can be accessed by any mysql client
244 | However, our docker compose also provides a pre-configured phpmyadmin container that can be used to access the database.
245 |
246 | What you need to do is the following:
247 |
248 | 1. **docker compose up phpmyadmin** to startup the phpmyadmin container
249 | 2. connect to **https://127.0.0.1:8080** (unless you changed the port)
250 | 3. insert the db credentials. By default: ac-database (host), root (user), password (password)
251 |
252 | You are ready to go!
253 |
254 | Check the [AzerothCore wiki](https://www.azerothcore.org/wiki/documentation_index) to learn how to work with the AC database
255 | ### Customize your server with Lua scripts
256 |
257 | The worldserver container included in our docker compose integrates the Eluna module
258 |
259 | You just need to install your lua scripts inside the /scripts/lua folder and you are ready to go!
260 |
261 | Check the [Eluna documentation](https://github.com/ElunaLuaEngine/Eluna/blob/master/README.md) to learn how to work with this system
262 |
263 | ### Customize your server with TypeScript
264 |
265 | This project also integrates the [Eluna-TS](https://github.com/azerothcore/eluna-ts) system which allows you to create your custom scripts in Typescript!
266 |
267 | What you need is just create an "index.ts" within the **/scripts/typescript** folder and you can directly start by writing your scripts there or creating other files to import.
268 |
269 | Inside our **docker compose.yml** there's the **ac-eluna-ts-dev** service which check changes on **/scripts/typescript** folder to automatically recompile your TS files into Lua.
270 |
271 | **Disclaimer:** Eluna-TS is based on [TypeScriptToLua](https://typescripttolua.github.io/) which is a Typescript limited environment. You cannot use all the Typescript features, check their page for more info.
272 |
273 | ### Extract client data by your self with the ac-dev-tools container
274 |
275 | Within your **.env** file set this variable: **DOCKER_CLIENT_DATA_FOLDER=** with the **absolute path** of the "Data" folder of your game client.
276 |
277 | Now run this command: **docker compose run --rm --no-deps ac-dev-tools bash** to access the shell of the **ac-dev-tools** container. Once inside you can run the following commands:
278 |
279 | * **./map_extractor** -> to extract dbc, Cameras and maps
280 | * **./vmap4_extractor && ./vmap4_assembler** -> to extract and assemble the vertical maps
281 | * **./mmaps_generator** -> to extract and generate the movement maps
282 |
283 | After the extraction (it can take hours) the file will be available inside the `ac-client-data-*` volumes.
284 |
285 |
286 |
--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-dinky
2 | markdown: kramdown
--------------------------------------------------------------------------------
/conf/dist/.env:
--------------------------------------------------------------------------------
1 | # Ports: these are the ports exposed to your host
2 | # you can change them accordingly to your needs
3 | DOCKER_WORLD_EXTERNAL_PORT=
4 | DOCKER_AUTH_EXTERNAL_PORT=
5 | DOCKER_SOAP_EXTERNAL_PORT=
6 | DOCKER_DB_EXTERNAL_PORT=
7 |
8 | # Directory of your game client "Data" folder
9 | DOCKER_CLIENT_DATA_FOLDER=
10 |
11 | # By default these volumes are bound to the ./var/* folder
12 | # you can change them if you need
13 | DOCKER_VOL_TOOLS_DBC=
14 | DOCKER_VOL_TOOLS_MAPS=
15 | DOCKER_VOL_TOOLS_VMAPS=
16 | DOCKER_VOL_TOOLS_MMAPS=
17 |
18 | # This is the password of the mysql root user
19 | # It will be set when your database is created
20 | DOCKER_DB_ROOT_PASSWORD=
21 |
22 | # used internally. check the docker-compose.yml
23 | DOCKER_IMAGE_TAG=
24 | DOCKER_USER=
--------------------------------------------------------------------------------
/conf/dist/docker-compose.override.yml:
--------------------------------------------------------------------------------
1 | version: '3.9'
2 |
3 | services:
4 | #=========================
5 | #
6 | # This override file contains all the configuration needed
7 | # to setup a second realm.
8 | # Remember to add this realm into your realmlist database.
9 | #
10 | #==========================
11 |
12 | ac-worldserver-2:
13 | working_dir: /azerothcore
14 | image: acore/ac-wotlk-worldserver:${DOCKER_IMAGE_TAG:-master}
15 | stdin_open: true
16 | tty: true
17 | restart: unless-stopped
18 | privileged: true
19 | ports:
20 | - ${DOCKER_WORLD_EXTERNAL_PORT:-8086}:8085
21 | - ${DOCKER_SOAP_EXTERNAL_PORT:-7879}:7878
22 | networks:
23 | - ac-network
24 | volumes:
25 | - ./conf/worldserver2.conf:/azerothcore/env/dist/etc/worldserver.conf
26 | - ./scripts/lua:/azerothcore/env/dist/bin/lua_scripts/scripts
27 | - ${DOCKER_VOL_TOOLS_DBC:-ac-client-data-dbc}:/azerothcore/env/dist/data/dbc:ro
28 | - ${DOCKER_VOL_TOOLS_MAPS:-ac-client-data-maps}:/azerothcore/env/dist/data/maps:ro
29 | - ${DOCKER_VOL_TOOLS_VMAPS:-ac-client-data-vmaps}:/azerothcore/env/dist/data/vmaps:ro
30 | - ${DOCKER_VOL_TOOLS_MMAPS:-ac-client-data-mmaps}:/azerothcore/env/dist/data/mmaps:ro
31 | depends_on:
32 | ac-database:
33 | condition: service_healthy
34 | ac-eluna-ts-dev:
35 | condition: service_started
36 | ac-client-data:
37 | condition: service_started
38 | ac-db-import-2:
39 | condition: service_completed_successfully
40 |
41 | ac-db-import-2:
42 | image: acore/ac-wotlk-worldserver:${DOCKER_IMAGE_TAG:-master}
43 | command: ./env/dist/bin/dbimport
44 | environment:
45 | AC_DISABLE_INTERACTIVE: "1"
46 | volumes:
47 | - ./conf/worldserver2.conf:/azerothcore/env/dist/etc/dbimport.conf
48 | networks:
49 | - ac-network
50 | depends_on:
51 | ac-database:
52 | condition: service_healthy
53 | ac-db-import:
54 | condition: service_completed_successfully
--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
1 | # extension field: https://docs.docker.com/compose/compose-file/compose-file-v3/#extension-fields
2 | x-networks: &networks
3 | networks:
4 | - ac-network
5 |
6 | x-ac-shared-conf: &ac-shared-conf
7 | <<: *networks
8 | working_dir: /azerothcore
9 | depends_on:
10 | ac-database:
11 | condition: service_healthy
12 |
13 | services:
14 | ac-database:
15 | <<: *networks
16 | image: mysql:8.0
17 | restart: unless-stopped
18 | cap_add:
19 | - SYS_NICE # CAP_SYS_NICE
20 | ports:
21 | - ${DOCKER_DB_EXTERNAL_PORT:-63306}:3306
22 | expose:
23 | - 3306
24 | environment:
25 | - MYSQL_ROOT_PASSWORD=${DOCKER_DB_ROOT_PASSWORD:-password}
26 | volumes:
27 | - type: volume
28 | source: ac-database
29 | target: /var/lib/mysql
30 | healthcheck:
31 | test: '/usr/bin/mysql --user=root --password=$$MYSQL_ROOT_PASSWORD --execute "SHOW DATABASES;"'
32 | interval: 2s
33 | timeout: 40s
34 | retries: 20
35 |
36 | ac-worldserver:
37 | container_name: acore-docker-ac-worldserver-1 # fixed container name to simplify the attach process
38 | <<: *ac-shared-conf
39 | stdin_open: true
40 | tty: true
41 | cap_add:
42 | - SYS_NICE # CAP_SYS_NICE
43 | image: acore/ac-wotlk-worldserver:${DOCKER_IMAGE_TAG:-master}
44 | restart: unless-stopped
45 | privileged: true
46 | user: ${DOCKER_USER:-acore}
47 | ports:
48 | - ${DOCKER_WORLD_EXTERNAL_PORT:-8085}:8085
49 | - ${DOCKER_SOAP_EXTERNAL_PORT:-7878}:7878
50 | expose:
51 | - 8085
52 | volumes:
53 | - ./scripts/lua:/azerothcore/env/dist/bin/lua_scripts/scripts
54 | - "${DOCKER_VOL_CLIENT_DATA:-ac-client-data}:/azerothcore/env/dist/data:ro"
55 |
56 | environment:
57 | AC_DATA_DIR: "/azerothcore/env/dist/data"
58 | AC_LOGS_DIR: "/azerothcore/env/dist/logs"
59 | AC_LOGIN_DATABASE_INFO: "ac-database;3306;root;${DOCKER_DB_ROOT_PASSWORD:-password};acore_auth"
60 | AC_WORLD_DATABASE_INFO: "ac-database;3306;root;${DOCKER_DB_ROOT_PASSWORD:-password};acore_world"
61 | AC_CHARACTER_DATABASE_INFO: "ac-database;3306;root;${DOCKER_DB_ROOT_PASSWORD:-password};acore_characters"
62 | AC_CLOSE_IDLE_CONNECTIONS: "0"
63 | depends_on:
64 | ac-eluna-ts-dev:
65 | condition: service_started
66 | ac-client-data:
67 | condition: service_completed_successfully
68 | ac-db-import:
69 | condition: service_completed_successfully
70 |
71 | ac-authserver:
72 | <<: *ac-shared-conf
73 | tty: true
74 | image: acore/ac-wotlk-authserver:${DOCKER_IMAGE_TAG:-master}
75 | restart: unless-stopped
76 | ports:
77 | - ${DOCKER_AUTH_EXTERNAL_PORT:-3724}:3724
78 | expose:
79 | - 3724
80 | environment:
81 | AC_LOGS_DIR: "/azerothcore/env/dist/logs"
82 | AC_TEMP_DIR: "/azerothcore/env/dist/temp"
83 | AC_LOGIN_DATABASE_INFO: "ac-database;3306;root;${DOCKER_DB_ROOT_PASSWORD:-password};acore_auth"
84 | AC_SQLDRIVER_LOG_FILE: "SQLDriver.log"
85 | AC_SQLDRIVER_QUERY_LOGGING: "1"
86 | depends_on:
87 | ac-database:
88 | condition: service_healthy
89 | ac-db-import:
90 | condition: service_completed_successfully
91 |
92 | ac-eluna-ts-dev:
93 | image: acore/eluna-ts:master
94 | # the build:lib is done in the healthcheck
95 | command: sh -c "cd /eluna-ts/modules && touch index.ts && npm install && cd /eluna-ts && npm run dev"
96 | # small workaround to make the other services to wait for the eluna-ts build
97 | healthcheck:
98 | test: sh -c "cd /eluna-ts/modules/eluna-ts && npm run build:lib && npm run build"
99 | timeout: 60s
100 | retries: 10
101 | interval: 5s
102 | start_period: 10s
103 | restart: unless-stopped
104 | volumes:
105 | # from typescript
106 | - ./scripts/typescript:/eluna-ts/modules
107 | # to lua
108 | - ./scripts/lua:/eluna-ts/dist/
109 |
110 | ac-client-data:
111 | <<: *networks
112 | image: acore/ac-wotlk-client-data:${DOCKER_IMAGE_TAG:-master}
113 | volumes:
114 | - "${DOCKER_VOL_CLIENT_DATA:-ac-client-data}:/azerothcore/env/dist/data"
115 |
116 | ac-db-import:
117 | <<: *ac-shared-conf
118 | image: acore/ac-wotlk-db-import:${DOCKER_IMAGE_TAG:-master}
119 | environment:
120 | AC_DISABLE_INTERACTIVE: "1"
121 | AC_DATA_DIR: "/azerothcore/env/dist/data"
122 | AC_LOGS_DIR: "/azerothcore/env/dist/logs"
123 | AC_LOGIN_DATABASE_INFO: "ac-database;3306;root;${DOCKER_DB_ROOT_PASSWORD:-password};acore_auth"
124 | AC_WORLD_DATABASE_INFO: "ac-database;3306;root;${DOCKER_DB_ROOT_PASSWORD:-password};acore_world"
125 | AC_CHARACTER_DATABASE_INFO: "ac-database;3306;root;${DOCKER_DB_ROOT_PASSWORD:-password};acore_characters"
126 | AC_CLOSE_IDLE_CONNECTIONS: "0"
127 | depends_on:
128 | ac-database:
129 | condition: service_healthy
130 |
131 | phpmyadmin:
132 | <<: *networks
133 | image: phpmyadmin
134 | ports:
135 | - 8080:80
136 | environment:
137 | - PMA_ARBITRARY=1
138 | profiles: []
139 |
140 | volumes:
141 | ac-database:
142 | ac-client-data:
143 |
144 | networks:
145 | ac-network:
146 |
--------------------------------------------------------------------------------
/scripts/lua/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/azerothcore/acore-docker/eae2b8dd3b75d3a0b73c77ebb4c5d8731e346064/scripts/lua/.gitkeep
--------------------------------------------------------------------------------
/scripts/typescript/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/azerothcore/acore-docker/eae2b8dd3b75d3a0b73c77ebb4c5d8731e346064/scripts/typescript/.gitkeep
--------------------------------------------------------------------------------
/scripts/typescript/examples/example.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * Example with arrow function
3 | *
4 | * This is just an Hello World
5 | */
6 | export const OnPlayerLogin: player_event_on_login = (event, player) => {
7 | player.SendChatMessageToPlayer(
8 | ChatMsg.CHAT_MSG_WHISPER,
9 | Language.LANG_UNIVERSAL,
10 | "Hello World",
11 | player
12 | );
13 | };
14 |
15 | RegisterPlayerEvent(PlayerEvents.PLAYER_EVENT_ON_LOGIN, (...args) =>
16 | OnPlayerLogin(...args)
17 | );
18 |
19 | /**
20 | *
21 | * This is an example of how to use TypeScript classes
22 | * and implement hook methods inside it.
23 | *
24 | * A class can be useful to implement more complex
25 | * scripts that can be instantiated or extended
26 | *
27 | */
28 | export class PlayerChat {
29 | previousMessage: string;
30 |
31 | /**
32 | *
33 | * @param firstMessage The first message to display
34 | */
35 | constructor(firstMessage: string) {
36 | this.previousMessage = firstMessage;
37 | }
38 |
39 | OnPlayerChat: player_event_on_chat = (
40 | event: number,
41 | player: Player,
42 | msg: string
43 | ): string | boolean => {
44 | const sanitized = msg;
45 |
46 | msg = sanitized != msg ? `${sanitized} (Sanitized)` : msg;
47 |
48 | player.SendChatMessageToPlayer(
49 | ChatMsg.CHAT_MSG_WHISPER,
50 | Language.LANG_UNIVERSAL,
51 | `Previous message: ${this.previousMessage}, current message: ${msg}`,
52 | player
53 | );
54 |
55 | this.previousMessage = msg;
56 |
57 | return true;
58 | };
59 | }
60 |
61 | const playerChat = new PlayerChat("First Message");
62 |
63 | RegisterPlayerEvent(PlayerEvents.PLAYER_EVENT_ON_CHAT, (...args) =>
64 | playerChat.OnPlayerChat(...args)
65 | );
66 |
--------------------------------------------------------------------------------
/scripts/typescript/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "acore-docker-ts",
3 | "version": "1.0.0",
4 | "description": "TS scripts for acore-docker",
5 | "dependencies": {
6 | "@azerothcore/eluna-ts-definitions": "^1.2.8",
7 | "@azerothcore/eluna-ts-lib": "^1.0.10"
8 | }
9 | }
10 |
--------------------------------------------------------------------------------
/scripts/typescript/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "strict": true,
4 | "target": "esnext",
5 | "lib": [
6 | "esnext"
7 | ],
8 | "moduleResolution": "node",
9 | "types": [
10 | "lua-types/5.2",
11 | "@azerothcore/eluna-ts-definitions",
12 | "@azerothcore/eluna-ts-lua"
13 | ],
14 | "typeRoots": [
15 | "./node_modules/@types",
16 | "./node_modules/@azerothcore/eluna-ts-definitions",
17 | "./node_modules/@azerothcore/eluna-ts-lua"
18 | ],
19 | "rootDir": "."
20 | },
21 | "include": [
22 | "**/*.ts"
23 | ]
24 | }
--------------------------------------------------------------------------------
/var/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/azerothcore/acore-docker/eae2b8dd3b75d3a0b73c77ebb4c5d8731e346064/var/.gitkeep
--------------------------------------------------------------------------------
/var/shared/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/azerothcore/acore-docker/eae2b8dd3b75d3a0b73c77ebb4c5d8731e346064/var/shared/.gitkeep
--------------------------------------------------------------------------------