🌍
gm_maxminddb_geoip
This module reads, queries and serializes to Lua tables data from the MaxMindDB GeoIP database.
In other words, IP address goes in, GeoIP data comes out.
Installation
Downloading the module
First, run this in your server's console and it will tell you which module you need to download from the releases page
lua_run print("gmsv_maxminddb_geoip_" .. ((system.IsLinux() and "linux" .. (jit.arch == "x86" and "" or "64")) or (system.IsWindows() and "win" .. (jit.arch == "x86" and "32" or "64")) or "UNSUPPORTED") .. ".dll")
Then, put the downloaded dll file in garrysmod/lua/bin, if that folder doesn't exist, create it.
Downloading the MaxMindDB GeoIP database
Click here to download the MaxMindDB GeoIP database
You'll need to create an account unfortunately. Alternatively, you could always download a sketchy one from GitHub if you are lazy.
One you've created an account, log in and go to "Download Files" or "Download Databases" and download the database you need.
Once downloaded, copy it to garrysmod/maxminddb.mmdb on your server.
Which MaxMindDB GeoIP database do I need?
If you only need country information, download "GeoLite2 Country" (NOT the CSV one)
Developers
All data available in the maxminddb crate documentation is serialized and available.
If you want to automate the downloading of the database in some way, the module will also accept a MaxMindDB stored in garrysmod/data/maxminddb.dat which can be written to using file.Write
Rust -> Lua Type Conversions
Not all servers will have the full databases installed, and the free database contains limited data, which most servers will install. Therefore, do note that every field can be nil.
| Rust | Lua | English |
|---|---|---|
BTreeMap
|
{ [K] = V, ... } |
A key-value table |
Vec
|
{ T, ... } |
A sequential table |
Option
|
T | nil |
Something that can be nil |
&str |
string |
Text |
f64 |
number |
A decimal number |
u32 u16 |
integer |
A positive integer |
Loading the module
require("maxminddb_geoip")
-- Prints the version of the module
print(maxminddb.VERSION)
-- This will reread the database from the disk, useful if you've just written to garrysmod/data/maxminddb.dat
-- You don't need to call this function after require()ing the module, it will load automatically
-- maxminddb.refresh() -> (success: bool, error: [string | nil])
maxminddb.refresh()
Simple Querying
-- Provided for convenience
-- maxminddb.country(ipAddress: string, lang: string = "en") -> [(country: string, nil) | (nil, error: string)]
local country, err = maxminddb.country("1.1.1.1", "en")
if err then
error(err)
else
print(country) -- "Australia"
end
Advanced Querying
-- Advanced querying
-- Records can be found here: https://docs.rs/maxminddb/latest/maxminddb/0.21.0
-- maxminddb.query(ipAddress: string, record) -> [(data: table, nil) | (nil, error: string)]
local data, err = maxminddb.query("1.1.1.1", maxminddb.records.Country)
if err then
error(err)
else
PrintTable(data) -- see below
end
-- Database used for example: GeoLite2-Country
continent:
code = "OC"
geoname_id = 6255151
names:
de = "Ozeanien"
en = "Oceania"
es = "Oceanía"
fr = "Océanie"
ja = "オセアニア"
pt-BR = "Oceania"
ru = "Океания"
zh-CN = "大洋洲"
country:
geoname_id = 2077456
iso_code = "AU"
names:
de = "Australien"
en = "Australia"
es = "Australia"
fr = "Australie"
ja = "オーストラリア"
pt-BR = "Austrália"
ru = "Австралия"
zh-CN = "澳大利亚"
registered_country:
geoname_id = 2077456
iso_code = "AU"
names:
de = "Australien"
en = "Australia"
es = "Australia"
fr = "Australie"
ja = "オーストラリア"
pt-BR = "Austrália"
ru = "Австралия"
zh-CN = "澳大利亚"
1.2k Dec 30, 2022
8 Sep 15, 2022
11 Dec 30, 2022
5 Feb 26, 2023
7 Apr 1, 2023
101 Nov 12, 2022
484 Jan 7, 2023
11 Aug 10, 2021
4 Aug 17, 2022
17 Dec 24, 2022
9 Oct 25, 2022
2 Sep 14, 2016
7 Sep 5, 2022
6 Sep 17, 2022
4 Jun 3, 2023
38 Dec 12, 2022
2 Jan 4, 2022
4 Mar 14, 2022
38 Jan 2, 2024
24 Dec 21, 2022
4 Dec 2, 2022