Skip to content

hmmhmmhm/ground.codes

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

157 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌍 ground.codes

Ground Codes Logo

🌐 Ground Code Web Demo: ground.codes
πŸŒ€ How Grok Spiral works: grok-spiral.ground.codes
πŸ“š API Documentation: api.ground.codes

πŸ” What is Ground Codes?

Ground Codes is a coordinate-based addressing system that allows you to pinpoint any location in the world using just a region name and two words (e.g., "Yongsan-Happiness-Smile"). It leverages geographic coordinate systems (GCS) to provide a user-friendly alternative to traditional latitude and longitude coordinates.

And Ground Codes is a multi-planetary addressing system πŸͺ that aims to provide a universal coordinate-based solution across celestial bodies. Currently operational on Earth, it will soon expand to support Mars and the Moon as part of its vision for a comprehensive multi-planetary address framework.

Warning

⚠️ ground.codes is an ongoing project and has not yet reached completion.

πŸ“¦ Packages & Apps

  • πŸ“ ground-codes: the core implementation package that provides the fundamental encoding and decoding functionality for the Ground Codes coordinate-based addressing system
  • πŸ—ΊοΈ @repo/geoint: a package for processing and providing curated geographical information about global regions with populations of 500 or more people
  • πŸ“– @repo/codebook: a package for managing the word codebooks used in the coordinate encoding system
  • πŸŒ€ apps/grok-spiral: an interactive visualization app demonstrating the Grok Spiral coordinate generation system that powers Ground Codes' geospatial indexing
  • πŸ–₯️ apps/web: the main web application featuring an interactive Google Maps interface with POI details, grid system, and multilingual support for the Ground Codes system
  • πŸš€ apps/api-ground-codes: the API server providing endpoints for Ground Codes encoding/decoding services with OpenAPI/Swagger documentation

✨ Key Features

  • 🧠 Simple and Memorable: Just three words to identify any location precisely
  • 🌎 Global Coverage: Works anywhere in the world with a unique address
  • πŸ”“ Open Source: MIT licensed and fully transparent implementation
  • 🌐 Multilingual Support: Currently available in Korean and English, with plans to expand to 60 languages
  • 🎯 Variable Precision: Offers three levels of precision (3m, 30cm, and 3cm) to suit different use cases

πŸ“Š Comparison with Similar Services

Service Format License Precision Global Usage Multilingual Support
🌍 Ground Codes Yongsan-Happiness-Smile βœ… MIT License (Free) 1. 3 meters (standard)
2. 30cm
3. 3cm
βœ… Yes 🌐 English, Korean, Chinese (expanding to 60 languages)
πŸ” Google Plus Code HX2F+J8 ⚠️ No License (Free) 3.5 meters ⚠️ Limited (requires 4 additional characters for global use, e.g., 8Q94HX2F+J8) πŸ‡¬πŸ‡§ English only
πŸ”€ What 3 Words ///teacher.awaken.days πŸ’° Proprietary (Paid) 3 meters βœ… Yes 🌐 60 languages

πŸ’ͺ Advantages Over Existing Services

πŸ”„ Compared to Google Plus Codes:

  • πŸ†” Ground Codes assigns globally unique addresses, while Plus Codes can be duplicated across different countries
  • 🧭 The region name prefix provides immediate geographic context

πŸ”„ Compared to What 3 Words:

  • πŸ†“ Open source and free under MIT license, unlike What 3 Words' proprietary commercial model
  • 🧭 The region name prefix gives immediate geographic context, while What 3 Words requires an app to determine approximate location

πŸ“ Variable Precision Format

Ground Codes offers different precision levels through simple syntax changes:

  • πŸ“ Yongsan-Happiness-Smile (3m precision) - Ideal for AI drone delivery destinations
  • πŸ” Yongsan#Happiness#Smile (30cm precision) - Suitable for autonomous vehicle navigation
  • πŸ”¬ Yongsan+Consideration+Happiness+Smile (3cm precision) - Perfect for AI humanoid robot applications

πŸ”Œ Integration and Access

Ground Codes is available through both web URLs and API access:

  • 🌐 Web URL: ground.codes/Yongsan-Happiness-Smile β†’ Shows the location on a map
  • πŸš€ API: api.ground.codes/Yongsan-Happiness-Smile β†’ Returns latitude/longitude coordinates in JSON format

API usage is limited to 600 requests per minute per IP. For higher volume needs, paid API options or open-source modules are available.

πŸ”§ Technical Details

  • πŸ‡¬πŸ‡§ English word set: 6,000 words (AI-generated dataset)
  • πŸ‡°πŸ‡· Korean word set: 5,630 words (AI-generated dataset)
  • 🌎 Region names: 210,000 unique global locations with populations of 500+ (GeoNames data, commercially usable)
  • πŸ” Special solutions:
    • Region 1: ✈️ Optimized for airports/logistics with country codes and airport codes (e.g., NYC-491AD, SSN-TA14C)
    • Region 0: πŸ›‘οΈ Security solution (military/commercial) with custom central points and FPE encryption

βš™οΈ How Ground Codes Works

Ground Codes uses a custom GIS algorithm called "Grok Spiral" πŸŒ€ that determines coordinates by moving in a clockwise spiral from a central point. This implementation leverages the "Gauss Circle Problem" formula to achieve O(sqrt N) efficiency in coordinate generation. The spiral pattern maintains a circular shape regardless of distance from the center point, resulting in excellent coordinate indexing efficiency.

πŸ“„ License

MIT License

About

Ground code come to exact earth (+mars) address

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  

Languages